diff --git a/dashboards.libsonnet b/dashboards.libsonnet index b9f1ebe..3f8f197 100644 --- a/dashboards.libsonnet +++ b/dashboards.libsonnet @@ -1,5 +1,8 @@ +local grr = import 'github.com/grafana/jsonnet-libs/grizzly/grizzly.libsonnet'; + { - grafanaDashboards+:: { - 'example.json': (import 'example.jsonnet'), - }, + dashboards: [ + grr.dashboard.new('example', (import 'example.jsonnet')), + ], + // See a more extensive example at https://github.com/grafana/grizzly/blob/main/examples/grr.jsonnet } diff --git a/jsonnetfile.json b/jsonnetfile.json index 2414c86..3471290 100644 --- a/jsonnetfile.json +++ b/jsonnetfile.json @@ -9,6 +9,15 @@ } }, "version": "main" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/jsonnet-libs.git", + "subdir": "grizzly" + } + }, + "version": "master" } ], "legacyImports": true diff --git a/jsonnetfile.lock.json b/jsonnetfile.lock.json index 5062d7d..83ce09a 100644 --- a/jsonnetfile.lock.json +++ b/jsonnetfile.lock.json @@ -1,26 +1,6 @@ { "version": 1, "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/crdsonnet.git", - "subdir": "crdsonnet" - } - }, - "version": "3dab27c8c9119eb14ecc19592240caf5f7330d23", - "sum": "Vh6Wo/7IIyIkmDE2XAJfWZDlTHClRrdMa9CCBPrcF1U=" - }, - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/validate-libsonnet.git", - "subdir": "" - } - }, - "version": "a78ca15fbfece3110c4807d1f059132ece01d97b", - "sum": "qYLH56MqvmgxE4YMNeTbuJ1XSsCpl1sumHN5x8IQv2I=" - }, { "source": { "git": { @@ -28,38 +8,28 @@ "subdir": "gen/grafonnet-latest" } }, - "version": "441b95e5a16ee5e511d54beb5f07e9b05f2bb5a2", - "sum": "sVzVlSLbxPkAurwO19YERigLMmRfVsViMcWC0gkTTqU=" - }, - { - "source": { - "git": { - "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "gen/grafonnet-v10.0.0" - } - }, - "version": "441b95e5a16ee5e511d54beb5f07e9b05f2bb5a2", - "sum": "Lv5DM6d93sW3q2v9l5A6V0Etnnrzy5t19uYTEjO77Ag=" + "version": "fe65a22df6d3a897729fff47cff599805a2c5710", + "sum": "mDHkB1avJU5IqvwCsXPmPt8pSiGjupLVqx3zCgFKzbw=" }, { "source": { "git": { "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "grafonnet-base" + "subdir": "gen/grafonnet-v10.2.0" } }, - "version": "441b95e5a16ee5e511d54beb5f07e9b05f2bb5a2", - "sum": "5zmj5Vn/cKhKrD+jA5BfLliR4t74upkM4PfnuJC5t4M=" + "version": "fe65a22df6d3a897729fff47cff599805a2c5710", + "sum": "9xwtVj7WmdsFWoQ5CTcvDBKEgIPnAF9DsD6dnKl3M/U=" }, { "source": { "git": { - "remote": "https://github.com/grafana/grok.git", - "subdir": "jsonnet/v10.0.0" + "remote": "https://github.com/grafana/jsonnet-libs.git", + "subdir": "grizzly" } }, - "version": "8a4d53df8dc53b005a22125bc199366787dd271a", - "sum": "cpxEEjeaQMUYA938vuVie3s5SSRv+O9IWwL9F1m44Qk=" + "version": "0098700428a0a4ee7d884d332d137caff5c52497", + "sum": "yY8w1JvVAuxB3Z62R3OxDVcSRPUKIvEWQZ2ShyD7uis=" }, { "source": { @@ -68,8 +38,8 @@ "subdir": "doc-util" } }, - "version": "7c865ec0606f2b68c0f6b2721f101e6a99cd2593", - "sum": "zjjufxN4yAIevldYEERiZEp27vK0BJKj1VvZcVtWiOo=" + "version": "6ac6c69685b8c29c54515448eaca583da2d88150", + "sum": "BrAL/k23jq+xy9oA7TWIhUx07dsA/QLm3g7ktCwe//U=" }, { "source": { @@ -78,8 +48,8 @@ "subdir": "" } }, - "version": "d1929c3c1728274424a21a617f1b82095685d640", - "sum": "DHqlMNfQH/eCWHbHD2Ouc/bH00AwTkCS86z6cgzQ7UI=" + "version": "fc2e57a8839902ed4ba6cab5a99d642500f7102b", + "sum": "43waffw1QzvpY4rKcWoo3L7Vpee+DCYexwLDd5cPG0M=" } ], "legacyImports": false diff --git a/vendor/crdsonnet b/vendor/crdsonnet deleted file mode 120000 index b4ffe1b..0000000 --- a/vendor/crdsonnet +++ /dev/null @@ -1 +0,0 @@ -github.com/crdsonnet/crdsonnet/crdsonnet \ No newline at end of file diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/dynamic.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/dynamic.libsonnet deleted file mode 100644 index 8bb1642..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/dynamic.libsonnet +++ /dev/null @@ -1,143 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -{ - local this = self, - - nilvalue:: {}, - - validate(schema, value):: true, - - nestInParents(name, parents, object):: - std.foldr( - function(p, acc) - if p == name - then acc - else { [p]+: acc } - , - parents, - object - ), - - functionName(name):: - local underscores = std.set(std.findSubstr('_', name)); - local n = std.join('', [ - if std.setMember(i - 1, underscores) - then std.asciiUpper(name[i]) - else name[i] - for i in std.range(0, std.length(name) - 1) - if !std.setMember(i, underscores) - ]); - 'with' + std.asciiUpper(n[0]) + n[1:], - - functionHelp(functionName, schema):: { - ['#%s' % functionName]:: - d.fn( - help=(if 'description' in schema - then schema.description - else ''), - args=( - if 'const' in schema - then [] - else [ - d.arg( - 'value', - type=( - if 'type' in schema - then schema.type - else 'string' - ), - default=( - if 'default' in schema - then schema.default - else null - ), - enums=( - if 'enum' in schema - then schema.enum - else null - ) - ), - ] - ) - ), - }, - - withFunction(schema):: - this.functionHelp(this.functionName(schema._name), schema) - + (if 'default' in schema - then { - [this.functionName(schema._name)](value=schema.default): - assert this.validate(schema, value); - this.nestInParents(schema._name, schema._parents, { [schema._name]: value }), - } - else { - [this.functionName(schema._name)](value): - assert this.validate(schema, value); - this.nestInParents(schema._name, schema._parents, { [schema._name]: value }), - }), - - withConstant(schema):: - this.functionHelp(this.functionName(schema._name), schema) - + { - [this.functionName(schema._name)](): - this.nestInParents(schema._name, schema._parents, { [schema._name]: schema.const }), - }, - - withBoolean(schema):: - this.functionHelp(this.functionName(schema._name), schema) - + { - [this.functionName(schema._name)](value=true): - assert this.validate(schema, value); - this.nestInParents(schema._name, schema._parents, { [schema._name]: value }), - }, - - mixinFunction(schema):: - this.functionHelp(this.functionName(schema._name) + 'Mixin', schema) - + { - [this.functionName(schema._name) + 'Mixin'](value): - assert this.validate(schema, value); - this.nestInParents(schema._name, schema._parents, { [schema._name]+: value }), - }, - - arrayFunctions(schema):: - this.functionHelp(this.functionName(schema._name), schema) - + this.functionHelp(this.functionName(schema._name) + 'Mixin', schema) - + { - [this.functionName(schema._name)](value): - assert this.validate(schema, value); - this.nestInParents( - schema._name, - schema._parents, - this.named(schema._name, if std.isArray(value) then value else [value]) - ), - - [this.functionName(schema._name) + 'Mixin'](value): - assert this.validate(schema, value); - this.nestInParents( - schema._name, - schema._parents, - this.named(schema._name, if std.isArray(value) then value else [value]) - ), - }, - - named(name, object):: - { - [name]+: object, - }, - - toObject(object):: - object, - - newFunction(parents):: - this.nestInParents( - 'new', - parents, - { - new(name): - self.withApiVersion() - + self.withKind() - + self.metadata.withName(name), - }, - ), -} - -// vim: foldmethod=indent diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/example_schema.json b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/example_schema.json deleted file mode 100644 index 11fee86..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/example_schema.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "$defs": { - "address": { - "properties": { - "street_address": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "country": { - "default": "United States of America", - "enum": [ - "United States of America", - "Canada" - ] - } - }, - "required": [ - "street_address", - "city", - "state" - ], - "type": "object" - } - }, - "$id": "https://example.com/schemas/customer", - "properties": { - "first_name": { - "type": "string" - }, - "last_name": { - "type": "string" - }, - "shipping_address": { - "$ref": "#/$defs/address" - }, - "billing_address": { - "$ref": "#/$defs/address" - } - }, - "required": [ - "first_name", - "last_name", - "shipping_address", - "billing_address" - ], - "type": "object" -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/jso b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/jso deleted file mode 100644 index e4d7419..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/jso +++ /dev/null @@ -1,18 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = import './example_schema.json'; - -local lib = crdsonnet.schema.render('customer', schema); -local c = lib.customer; - -local shippingAddress = - local address = c.shipping_address; - address.withStreetAddress('12 Church Lane') - + address.withCity('West York') - + address.withState('Dobberton') - + address.withCountry(); - -c.withFirstName('John') -+ c.withLastName('Doe') -+ shippingAddress -+ c.withBillingAddress(shippingAddress.shipping_address) diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema.libsonnet deleted file mode 100644 index e4d7419..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema.libsonnet +++ /dev/null @@ -1,18 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = import './example_schema.json'; - -local lib = crdsonnet.schema.render('customer', schema); -local c = lib.customer; - -local shippingAddress = - local address = c.shipping_address; - address.withStreetAddress('12 Church Lane') - + address.withCity('West York') - + address.withState('Dobberton') - + address.withCountry(); - -c.withFirstName('John') -+ c.withLastName('Doe') -+ shippingAddress -+ c.withBillingAddress(shippingAddress.shipping_address) diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_simple.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_simple.libsonnet deleted file mode 100644 index 9d06334..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_simple.libsonnet +++ /dev/null @@ -1,9 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = import './example_schema.json'; - -local lib = crdsonnet.schema.render('customer', schema); -local c = lib.customer; - -c.withFirstName('John') -+ c.withLastName('Doe') diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static.libsonnet deleted file mode 100644 index ec6006e..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static.libsonnet +++ /dev/null @@ -1,9 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = import './example_schema.json'; - -local staticProcessor = - crdsonnet.processor.new() - + crdsonnet.processor.withRenderEngineType('static'); - -crdsonnet.schema.render('customer', schema, staticProcessor) diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static_output.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static_output.libsonnet deleted file mode 100644 index 79c210a..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static_output.libsonnet +++ /dev/null @@ -1,22 +0,0 @@ -{ - customer+: { - withBillingAddress(value): { billing_address: value }, - withBillingAddressMixin(value): { billing_address+: value }, - billing_address+: { - withCity(value): { billing_address+: { city: value } }, - withCountry(value='United States of America'): { billing_address+: { country: value } }, - withState(value): { billing_address+: { state: value } }, - withStreetAddress(value): { billing_address+: { street_address: value } }, - }, - withFirstName(value): { first_name: value }, - withLastName(value): { last_name: value }, - withShippingAddress(value): { shipping_address: value }, - withShippingAddressMixin(value): { shipping_address+: value }, - shipping_address+: { - withCity(value): { shipping_address+: { city: value } }, - withCountry(value='United States of America'): { shipping_address+: { country: value } }, - withState(value): { shipping_address+: { state: value } }, - withStreetAddress(value): { shipping_address+: { street_address: value } }, - }, - }, -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple.libsonnet deleted file mode 100644 index 0f673ac..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple.libsonnet +++ /dev/null @@ -1,14 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = { - type: 'object', - properties: { - name: { - type: 'string', - }, - }, -}; - -local lib = crdsonnet.schema.render('person', schema); - -lib.person.withName('John') diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_static.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_static.libsonnet deleted file mode 100644 index f418c56..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_static.libsonnet +++ /dev/null @@ -1,16 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = { - type: 'object', - properties: { - name: { - type: 'string', - }, - }, -}; - -local staticProcessor = - crdsonnet.processor.new() - + crdsonnet.processor.withRenderEngineType('static'); - -crdsonnet.schema.render('person', schema, staticProcessor) diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet deleted file mode 100644 index 0afa132..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet +++ /dev/null @@ -1,18 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = { - type: 'object', - properties: { - name: { - type: 'string', - }, - }, -}; - -local validateProcessor = - crdsonnet.processor.new() - + crdsonnet.processor.withValidation(); - -local lib = crdsonnet.schema.render('person', schema, validateProcessor); - -lib.person.withName(100) // invalid input diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet.output b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet.output deleted file mode 100644 index 13a7c61..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet.output +++ /dev/null @@ -1,12 +0,0 @@ -TRACE: vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet:94 -Invalid parameters: - Parameter name is invalid: - Value 100 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - dynamic.libsonnet:(74:12)-(75:88) - example/json_schema_very_simple_validate.libsonnet:18:1-25 $ - During evaluation - diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/helpers.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/helpers.libsonnet deleted file mode 100644 index 8b39e83..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/helpers.libsonnet +++ /dev/null @@ -1,96 +0,0 @@ -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -{ - camelCaseKind(kind): - local s = xtd.camelcase.split(kind); - std.asciiLower(s[0]) + std.join('', s[1:]), - - getGroupKey(group, suffix): - // If no dedicated API group, then use 'nogroup' key for consistency - if suffix == group - then 'nogroup' - else std.split(std.strReplace( - group, - '.' + suffix, - '' - ), '.')[0], - - metadataRefSchemaDB: { - 'https://objectmeta/schema': import 'objectmeta.json', - }, - - properties: { - withMetadataRef(): { - // foldStart - properties+: { - metadata+: { - '$ref': 'https://objectmeta/schema#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta', - }, - }, - }, - // foldEnd - - withGroupVersionKind(group, version, kind): { - // foldStart - properties+: { - apiVersion+: { - const: - if group == '' - then version - else group - + '/' - + version, - }, - kind+: { - const: kind, - }, - }, - }, - // foldEnd - - withCompositeResource(): { - // foldStart - properties+: { - spec+: { - properties+: { - compositionRef: { - properties: { name: { type: 'string' } }, - required: ['name'], - type: 'object', - }, - compositionRevisionRef: { - properties: { name: { type: 'string' } }, - required: ['name'], - type: 'object', - }, - compositionSelector: { - properties: { - matchLabels: { - additionalProperties: { type: 'string' }, - type: 'object', - }, - }, - required: ['matchLabels'], - type: 'object', - }, - compositionUpdatePolicy: { - enum: [ - 'Automatic', - 'Manual', - ], - type: 'string', - }, - writeConnectionSecretToRef: { - properties: { name: { type: 'string' } }, - required: ['name'], - type: 'object', - }, - }, - }, - }, - }, - // foldEnd - }, -} - -// vim: foldmethod=marker foldmarker=foldStart,foldEnd foldlevel=0 diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet deleted file mode 100644 index f531d31..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet +++ /dev/null @@ -1,205 +0,0 @@ -local helpers = import './helpers.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - '#': - d.package.new( - 'crdsonnet', - 'https://github.com/crdsonnet/crdsonnet/crdsonnet', - 'Generate a *runtime* Jsonnet library directly from JSON Schemas, CRDs or OpenAPI components.', - std.thisFile, - 'master', - ) - + d.package.withUsageTemplate( - '%(json_schema_simple)s' % { - json_schema_simple: std.strReplace( - importstr './example/json_schema_simple.libsonnet', - '../main.libsonnet', - 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet', - ), - } - ), - - local root = self, - schemaDB: import './schemadb.libsonnet', - renderEngine: import './render.libsonnet', - processor: import './processor.libsonnet', - - schema: { - '#render': d.fn( - '`render` returns a library for a `schema`.', - args=[ - d.arg('name', d.T.string), - d.arg('schema', d.T.object), - d.arg('processor', d.T.object, default='processor.new()'), - ], - ), - render( - name, - schema, - processor=root.processor.new(), - ): - processor.render(name, schema), - }, - - crd: { - local this = self, - '#render': d.fn( - '`render` returns a library for a `definition`.', - args=[ - d.arg('definition', d.T.object), - d.arg('groupSuffix', d.T.string), - d.arg('processor', d.T.object, default='processor.new()'), - ], - ), - render( - definition, - groupSuffix, - processor=root.processor.new(), - ): - local _processor = - processor - + root.processor.withSchemaDB(helpers.metadataRefSchemaDB); - local renderEngine = _processor.renderEngine; - local grouping = helpers.getGroupKey(definition.spec.group, groupSuffix); - local name = helpers.camelCaseKind(this.getKind(definition)); - std.foldl( - function(acc, version) - local schema = this.getSchemaForVersion(definition, version); - acc - + renderEngine.toObject( - renderEngine.nestInParents( - [grouping, version.name], - _processor.render(name, schema) - ) - ) - + renderEngine.newFunction( - [grouping, version.name, name] - ) - , - definition.spec.versions, - renderEngine.nilvalue, - ), - getKind(definition): - definition.spec.names.kind, - getSchemaForVersion(definition, version): - version.schema.openAPIV3Schema - + helpers.properties.withMetadataRef() - + helpers.properties.withGroupVersionKind( - definition.spec.group, - version.name, - this.getKind(definition) - ), - }, - - // XRD: Crossplane CompositeResourceDefinition - // XRDs are very similar to CRDs, processing them requires slightly different behavior. - xrd: - self.crd - + { - getKind(definition): - if std.objectHas(definition.spec, 'claimNames') - then definition.spec.claimNames.kind - else definition.spec.names.kind, - getSchemaForVersion(definition, version): - super.getSchemaForVersion(definition, version) - + helpers.properties.withCompositeResource(), - }, - - openapi: { - '#render': d.fn( - '`render` returns a library for a `component` in an OpenAPI `schema`.', - args=[ - d.arg('name', d.T.string), - d.arg('component', d.T.object), - d.arg('schema', d.T.object), - d.arg('processor', d.T.object, default='processor.new()'), - ], - ), - render( - name, - component, - schema, - processor=root.processor.new(), - ): - local extendSchema = - std.mergePatch( - schema, - component - + (if 'x-kubernetes-group-version-kind' in component - then - // not sure why this is a list, grabbing the first item - local gvk = component['x-kubernetes-group-version-kind'][0]; - helpers.properties.withGroupVersionKind(gvk.group, gvk.version, gvk.kind) - else {}) - ); - processor.render(name, extendSchema) - + (if 'x-kubernetes-group-version-kind' in component - then processor.renderEngine.newFunction([name]) - else processor.renderEngine.nilvalue), - }, -} - -// Legacy API endpoints -// These endpoints aren't very flexible and require more arguments to add features, this is an anti-pattern. They have been reimplemented to use above modular setup as an example and to verify the modular pattern works. These functions are covered by unit tests. -+ { - local root = self, - local defaultRender = 'dynamic', - - fromSchema(name, schema, schemaDB={}, render=defaultRender): - if name == '' - then error "name can't be an empty string" - else - local _processor = - root.processor.new() - + root.processor.withSchemaDB(schemaDB) - + root.processor.withRenderEngineType(render); - self.schema.render(name, schema, _processor), - - fromCRD(definition, groupSuffix, schemaDB={}, render=defaultRender): - local _processor = - root.processor.new() - + root.processor.withSchemaDB(schemaDB) - + root.processor.withRenderEngineType(render); - self.crd.render(definition, groupSuffix, _processor), - - // XRD: Crossplane CompositeResourceDefinition - fromXRD(definition, groupSuffix, schemaDB={}, render=defaultRender): - local _processor = - root.processor.new() - + root.processor.withSchemaDB(schemaDB) - + root.processor.withRenderEngineType(render); - self.xrd.render(definition, groupSuffix, _processor), - - fromOpenAPI(name, component, schema, schemaDB={}, render=defaultRender): - if name == '' - then error "name can't be an empty string" - else - local _processor = - root.processor.new() - + root.processor.withSchemaDB(schemaDB) - + root.processor.withRenderEngineType(render); - self.openapi.render(name, component, schema, _processor), - - // expects schema as rendered by `kubectl get --raw /openapi/v2` - fromKubernetesOpenAPI(schema, render=defaultRender): - local _processor = - root.processor.new() - + root.processor.withRenderEngineType(render); - local renderEngine = _processor.renderEngine; - std.foldl( - function(acc, d) - local items = std.reverse(std.split(d, '.')); - local component = schema.definitions[d]; - local name = helpers.camelCaseKind(items[0]); - acc - + renderEngine.toObject( - renderEngine.nestInParents( - [items[2], items[1]], - self.fromOpenAPI(name, component, schema, render=render), - ) - ), - std.objectFields(schema.definitions), - renderEngine.nilvalue - ), -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/objectmeta.json b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/objectmeta.json deleted file mode 100644 index 04ad407..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/objectmeta.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "definitions": { - "io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta": { - "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations", - "type": "object" - }, - "clusterName": { - "description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.", - "type": "string" - }, - "creationTimestamp": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time", - "description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" - }, - "deletionGracePeriodSeconds": { - "description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.", - "format": "int64", - "type": "integer" - }, - "deletionTimestamp": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time", - "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" - }, - "finalizers": { - "description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.", - "items": { - "type": "string" - }, - "type": "array", - "x-kubernetes-patch-strategy": "merge" - }, - "generateName": { - "description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency", - "type": "string" - }, - "generation": { - "description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.", - "format": "int64", - "type": "integer" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels", - "type": "object" - }, - "managedFields": { - "description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.", - "items": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry" - }, - "type": "array" - }, - "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names", - "type": "string" - }, - "namespace": { - "description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces", - "type": "string" - }, - "ownerReferences": { - "description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.", - "items": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference" - }, - "type": "array", - "x-kubernetes-patch-merge-key": "uid", - "x-kubernetes-patch-strategy": "merge" - }, - "resourceVersion": { - "description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency", - "type": "string" - }, - "selfLink": { - "description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.", - "type": "string" - }, - "uid": { - "description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids", - "type": "string" - } - }, - "type": "object" - }, - "io.k8s.apimachinery.pkg.apis.meta.v1.Time": { - "description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.", - "format": "date-time", - "type": "string" - }, - "io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference": { - "description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.", - "properties": { - "apiVersion": { - "description": "API version of the referent.", - "type": "string" - }, - "blockOwnerDeletion": { - "description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.", - "type": "boolean" - }, - "controller": { - "description": "If true, this reference points to the managing controller.", - "type": "boolean" - }, - "kind": { - "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", - "type": "string" - }, - "name": { - "description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names", - "type": "string" - }, - "uid": { - "description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids", - "type": "string" - } - }, - "required": [ - "apiVersion", - "kind", - "name", - "uid" - ], - "type": "object", - "x-kubernetes-map-type": "atomic" - } - }, - "info": { - "title": "Kubernetes", - "version": "unversioned" - }, - "swagger": "2.0" -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/parser.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/parser.libsonnet deleted file mode 100644 index 1a2bb79..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/parser.libsonnet +++ /dev/null @@ -1,132 +0,0 @@ -local resolver = import './resolver.libsonnet'; -{ - local this = self, - - resolveRef: resolver.resolve, - - getRefName(ref): std.reverse(std.split(ref, '/'))[0], - - parseSchema(key, schema, currentSchema, schemaDB={}, parents=[]): - // foldStart - if std.isBoolean(schema) - then { [key]+: schema } - else if !std.isObject(schema) - then error 'Schema is not an object or boolean' - else - local schemaToParse = - resolver.resolveRef( - schema, - currentSchema, - schemaDB - ); - - // shortcut to make it more readable below - // requires the parseSchema* functions to have the same signature - local parse(k, f) = - (if k in schemaToParse - then - local parsed = f( - key, - schemaToParse[k], - currentSchema, - schemaDB, - parents, - ); - if parsed != null - then { [k]: parsed } - else {} - else {}); - - { - [key]+: - schemaToParse - + parse('properties', this.parseSchemaMap) - + parse('patternProperties', this.parseSchemaMap) - + parse('items', this.parseSchemaItems) - + parse('then', this.parseSchemaSingle) - + parse('else', this.parseSchemaSingle) - + parse('prefixItems', this.parseSchemaList) - + parse('allOf', this.parseSchemaList) - + parse('anyOf', this.parseSchemaList) - + parse('oneOf', this.parseSchemaList) - + { _parents:: parents }, - } - , - // foldEnd - - parseSchemaItems(key, schema, currentSchema, schemaDB, parents): - self.parseSchemaSingle(key, schema, currentSchema, schemaDB, []), - - parseSchemaSingle(key, schema, currentSchema, schemaDB, parents): - // foldStart - local i = - if std.length(parents) > 0 - then std.length(parents) - 1 - else 0; - - local parsed = - this.parseSchema( - key, - schema, - currentSchema, - schemaDB, - parents[0:i] - ); - if parsed != null - then - if std.isObject(parsed[key]) - then parsed[key] + { _name:: key } - else parsed[key] - else {}, - // foldEnd - - parseSchemaMap(key, map, currentSchema, schemaDB, parents): - // foldStart - std.foldl( - function(acc, k) - acc - + this.parseSchema( - k, - map[k], - currentSchema, - schemaDB, - parents + [k], - ) - + { [k]+: { _name:: k } }, - std.objectFields(map), - {} - ), - // foldEnd - - parseSchemaList(key, list, currentSchema, schemaDB, parents): - // foldStart - [ - local parsed = - this.parseSchema( - key, - item, - currentSchema, - schemaDB, - parents, - )[key]; - - // Due to the nature of list items in JSON they don't have a key we can use as - // a name. However we can deduct the name from $ref or use $anchor if those are - // available. The name can later be used to create proper functions. - local name = - if std.isObject(item) - && '$anchor' in item - then item['$anchor'] - else if std.isObject(item) - && '$ref' in item - then this.getRefName(item['$ref']) - else ''; - - // Because order may matter (for example for prefixItems), we return a list. - parsed + { [if name != '' then '_name']:: name } - for item in list - ], - // foldEnd -} - -// vim: foldmethod=marker foldmarker=foldStart,foldEnd foldlevel=0 diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/processor.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/processor.libsonnet deleted file mode 100644 index 391cba2..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/processor.libsonnet +++ /dev/null @@ -1,87 +0,0 @@ -local parser = import './parser.libsonnet'; -local renderEngine = import './render.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - '#': d.package.newSub( - 'processor', - ||| - `processor` provides an interface to configure the parser and render engine, returns a parser() and render() function. - ||| - ), - - '#new': d.fn( - ||| - `new` initializes the processor with sane defaults, returning a parser() and render() function. - |||, - ), - new(): { - schemaDB: {}, - renderEngine: renderEngine.new('dynamic'), - parse(name, schema): - parser.parseSchema( - name, - schema, - schema, - self.schemaDB - ) + { [name]+: { _name: name } }, - render(name, schema): - local parsedSchema = self.parse(name, schema); - self.renderEngine.render(parsedSchema[name]), - }, - '#withSchemaDB': d.fn( - ||| - `withSchemaDB` adds additional schema databases. These can be created with `crdsonnet.schemaDB`. - |||, - args=[d.arg('db', d.T.object)], - ), - withSchemaDB(db): { - schemaDB+: db, - }, - '#withRenderEngine': d.fn( - ||| - `withRenderEngine` configures an alternative render engine. This can be created with `crdsonnet.renderEngine`. - |||, - args=[d.arg('engine', d.T.object)], - ), - withRenderEngine(engine): { - renderEngine: engine, - }, - '#withRenderEngineType': d.fn( - ||| - `withRenderEngineType` is a shortcut to configure an alternative render engine type. - |||, - args=[d.arg('engineType', d.T.string, enums=['dynamic', 'static'])], - ), - withRenderEngineType(engineType): - self.withRenderEngine(renderEngine.new(engineType)), - '#withValidation': d.fn( - ||| - `withValidation` turns on schema validation for render engine 'dynamic'. The `with*()` functions will validate the inputs against the given schema. - - NOTE: This uses validate-libsonnet, it can validate the most common JSON Schema attributes however some features are not yet implemented, most notably it is missing support for features that require regular expressions (not supported in Jsonnet yet). - - Example: - - ```jsonnet - %(example)s - ``` - - Output: - - ```console - %(output)s - ``` - ||| % { - example: std.strReplace( - importstr './example/json_schema_very_simple_validate.libsonnet', - '../main.libsonnet', - 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet', - ), - output: importstr 'example/json_schema_very_simple_validate.libsonnet.output', - } - ), - withValidation(): { - renderEngine+: renderEngine.withValidation(), - }, -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/render.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/render.libsonnet deleted file mode 100644 index fef5c86..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/render.libsonnet +++ /dev/null @@ -1,207 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - local engineTypes = { - static: import 'static.libsonnet', - dynamic: import 'dynamic.libsonnet', - }, - - '#': d.package.newSub( - 'renderEngine', - '`renderEngine` provides an interface to create a renderEngine.', - ), - - '#new': d.fn( - '`new` returns a renderEngine.', - args=[ - d.arg('engineType', d.T.string, enums=['static', 'dynamic']), - ], - ), - new(engineType): { - engine: engineTypes[engineType], - local r = self.engine, - - nilvalue: r.nilvalue, - toObject: r.toObject, - nestInParents(parents, object): r.nestInParents('', parents, object), - newFunction: r.newFunction, - - render(schema): - r.toObject(self.schema(schema)), - - schema(schema): - // foldStart - if 'const' in schema - then self.const(schema) // value is a constant - - else if 'type' in schema - then - if std.isBoolean(schema.type) - then - if schema.type - then self.other(schema) // Any value allowed - else r.nilvalue // No value allowed - - else if std.isArray(schema.type) - then self.other(schema) // Multiple types - - else if schema.type == 'object' - then self.object(schema) // type=object - - else if schema.type == 'array' - then self.array(schema) // type=array - - else if schema.type == 'boolean' - then self.boolean(schema) // type=boolean - - else self.other(schema) // any other type - - else if 'allOf' in schema - || 'anyOf' in schema - || 'oneOf' in schema - then self.xof(schema) // value can be xOf - - else self.other(schema) - , - // foldEnd - - nameParsed(schema, parsed): - // foldStart - if '_name' in schema - && parsed != r.nilvalue - then - r.named( - schema._name, - r.toObject( - parsed - ) - ) - else - parsed - , - // foldEnd - - functions(schema): - // foldStart - if std.length(schema._parents) != 0 && '_name' in schema - then r.withFunction(schema) - + r.mixinFunction(schema) - else r.nilvalue, - // foldEnd - - xofParts(schema): - // foldStart - local handle(schema, k) = - if k in schema - then - std.foldl( - function(acc, n) - acc + self.schema(n), - schema[k], - r.nilvalue - ) - else r.nilvalue; - { - allOf: handle(schema, 'allOf'), - anyOf: handle(schema, 'anyOf'), - oneOf: handle(schema, 'oneOf'), - - combined: - handle(schema, 'allOf') - + handle(schema, 'anyOf') - + handle(schema, 'oneOf'), - }, - // foldEnd - - const(schema): r.withConstant(schema), - - boolean(schema): - if '_name' in schema - then r.withBoolean(schema) - else r.nilvalue, - - other(schema): - // foldStart - if std.length(schema._parents) != 0 && '_name' in schema - then r.withFunction(schema) - else r.nilvalue, - //foldEnd - - object(schema): - // foldStart - local properties = ( - if 'properties' in schema - then - std.foldl( - function(acc, p) - acc + self.schema(schema.properties[p]), - std.objectFields(schema.properties), - r.nilvalue - ) - else r.nilvalue - ); - - local xofParts = self.xofParts(schema + { _parents: super._parents[1:] }); - - local merge(parts) = - if std.isObject(parts) - then - std.foldl( - function(acc, k) - acc + - (if std.isObject(parts[k]) - then parts[k] - else {}), - std.objectFields(parts), - {} - ) - else parts; // Can't merge in static mode - - // Merge allOf/anyOf as they can be used in combination with each other - // Keep oneOf seperate as it they would not be used in combination with each other - local parsed = - merge(xofParts.allOf) - + merge(xofParts.anyOf) - + xofParts.oneOf - + properties; - - self.functions(schema) - + self.nameParsed(schema, parsed), - // foldEnd - - array(schema): - // foldStart - (if '_name' in schema - then r.arrayFunctions(schema) - else r.nilvalue) - + ( - if 'items' in schema - && std.isObject(schema.items) - then self.schema(schema.items + { _parents: [] }) - else r.nilvalue - ), - // foldEnd - - xof(schema): - // foldStart - local parsed = self.xofParts(schema).combined; - self.functions(schema) - + self.nameParsed(schema, parsed), - // foldEnd - }, - withValidation(): { - engine+: { - validate(schema, value):: - local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet'; - validate.checkParameters({ - [schema._name]: - validate.schemaCheck( - value, - schema - ), - }), - }, - }, -} - -// vim: foldmethod=marker foldmarker=foldStart,foldEnd foldlevel=0 diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/resolver.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/resolver.libsonnet deleted file mode 100644 index 60c39d6..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/resolver.libsonnet +++ /dev/null @@ -1,116 +0,0 @@ -local schemadb_util = import './schemadb.libsonnet'; - -{ - local url = { - // Similar to Python's urllib.urlsplit() - // :///?# - split(url): - local hasFragment = std.length(std.findSubstr('#', url)) > 0; - local fragmentSplit = std.splitLimit(url, '#', 1); - - local hasQuery = std.length(std.findSubstr('?', fragmentSplit[0])) > 0; - local querySplit = std.splitLimit(fragmentSplit[0], '?', 1); - - local hasScheme = std.length(std.findSubstr(':', querySplit[0])) > 0; - local schemeSplit = std.splitLimit(querySplit[0], ':', 1); - - local postSchemeURL = - if hasScheme - then schemeSplit[1] - else schemeSplit[0]; - local hasNetLoc = std.startsWith(postSchemeURL, '//'); - local netLocSplit = std.splitLimit(postSchemeURL, '//', 1); - - local postNetLocURL = - if hasNetLoc - then netLocSplit[1] - else netLocSplit[0]; - local pathSplit = std.splitLimit(postNetLocURL, '/', 1); - local hasPath = - (hasNetLoc && std.length(std.findSubstr('/', postNetLocURL)) > 0) - || (!hasNetLoc && std.startsWith(postNetLocURL, '/')); - { - [if hasScheme then 'scheme']: schemeSplit[0], - [if hasNetLoc then 'net_loc']: pathSplit[0], - [if hasPath then 'path']: pathSplit[1], - [if hasQuery then 'query']: querySplit[1], - [if hasFragment then 'fragment']: fragmentSplit[1], - }, - - join(splitObj): - std.join('', [ - if 'scheme' in splitObj then splitObj.scheme + ':' else '', - if 'net_loc' in splitObj then '//' + splitObj.net_loc else '', - if 'path' in splitObj then '/' + splitObj.path else '', - if 'query' in splitObj then '?' + splitObj.query else '', - if 'fragment' in splitObj then '#' + splitObj.fragment else '', - ]), - }, - - resolveRef(obj, schema, schemaDB): - if '$ref' in obj - then self.resolve(obj['$ref'], schema, schemaDB) - else obj, - - resolve(ref, schema, schemaDB): - local splitRef = url.split(ref); - local splitID = url.split(schemadb_util.getID(schema)); - - local findSchema = - if self.urlWithPath(splitRef) == self.urlWithPath(splitID) // same as schema - then schema - - else if 'net_loc' in splitRef // absolute - then self.getSchemaFromDB( - self.urlWithPath(splitRef), - schemaDB, - ) - - else if 'path' in splitRef // relative - then self.getSchemaFromDB( - self.urlWithPath(splitID + splitRef), - schemaDB, - ) - - else if 'fragment' in splitRef // fragment - then schema - - else {}; // no schema found - - self.findFragment( - std.get(splitRef, 'fragment', ''), - findSchema, - schemaDB, - ), - - urlWithPath(parsedURL): - url.join({ - [if 'scheme' in parsedURL then 'scheme']: parsedURL.scheme, - [if 'net_loc' in parsedURL then 'net_loc']: parsedURL.net_loc, - [if 'path' in parsedURL then 'path']: parsedURL.path, - }), - - getSchemaFromDB(id, schemaDB): - local found = schemadb_util.get( - schemaDB, - id, - ); - self.resolveRef( - found, - found, - schemaDB - ), - - findFragment(fragment, schema, schemaDB={}): - local keys = std.split(fragment, '/')[1:]; - std.foldl( - function(acc, key) - self.resolveRef( - std.get(acc, key, {}), - schema, - schemaDB, - ), - keys, - schema - ), -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/schemadb.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/schemadb.libsonnet deleted file mode 100644 index e8dd617..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/schemadb.libsonnet +++ /dev/null @@ -1,44 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - '#': d.package.newSub( - 'schemaDB', - '`schemaDB` provides an interface to describe a schemaDB.', - ), - - '#get': d.fn( - "`get` gets a schema from a 'db'.", - args=[ - d.arg('db', d.T.object), - d.arg('name', d.T.string), - ], - ), - get(db, name): - std.get(db, name, {}), - - '#add': d.fn( - "`add` adds a schema to a 'db', expects a schema to have either am `$id` or `id` field.", - args=[d.arg('schema', d.T.object)], - ), - add(schema): - local id = self.getID(schema); - if id == '' - then error "Can't add schema without id" - else { [id]: schema }, - - '#getID': d.fn( - '`getID` gets the ID from a schema, either `$id` or `id` are returned.', - args=[d.arg('schema', d.T.object)], - ), - getID(schema): - std.get( - schema, - '$id', - std.get( - schema, - 'id', - '' - ) - ), - -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/static.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/static.libsonnet deleted file mode 100644 index b89cd8d..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/static.libsonnet +++ /dev/null @@ -1,131 +0,0 @@ -{ - local this = self, - - nilvalue:: '', - - nestInParents(name, parents, object):: - local obj = std.stripChars( - object, - '{}', // Remove curly brackets it can be nested in parents - ); - std.foldr( - function(p, acc) - if p == name - then acc - else '"' + p + '"+: { ' + acc + ' }', - parents, - obj - ), - - functionName(name):: - local underscores = std.set(std.findSubstr('_', name)); - local n = std.join('', [ - if std.setMember(i - 1, underscores) - then std.asciiUpper(name[i]) - else name[i] - for i in std.range(0, std.length(name) - 1) - if !std.setMember(i, underscores) - ]); - 'with' + std.asciiUpper(n[0]) + n[1:], - - withFunction(schema):: - ||| - %s(value%s): { %s }, - ||| % [ - this.functionName(schema._name), - (if 'default' in schema - then '=%s' % (if std.isString(schema.default) - then '"%s"' % schema.default - else schema.default) - else ''), - this.nestInParents( - schema._name, - schema._parents, - '"%s": value' % schema._name - ), - ], - - withConstant(schema):: - ||| - %s(): { %s }, - ||| % [ - this.functionName(schema._name), - this.nestInParents( - schema._name, - schema._parents, - '"%s": "%s"' % [schema._name, schema.const] - ), - ], - - withBoolean(schema):: - ||| - %s(value=%s): { %s }, - ||| % [ - this.functionName(schema._name), - (if 'default' in schema - then schema.default - else 'true'), - this.nestInParents( - schema._name, - schema._parents, - '"%s": value' % schema._name - ), - ], - - mixinFunction(schema):: - ||| - %sMixin(value): { %s }, - ||| % [ - this.functionName(schema._name), - this.nestInParents( - schema._name, - schema._parents, - '"%s"+: value' % schema._name - ), - ], - - arrayFunctions(schema):: - ||| - %s(value): { %s }, - %sMixin(value): { %s }, - ||| % [ - this.functionName(schema._name), - this.nestInParents( - schema._name, - schema._parents, - ' "%s": if std.isArray(value) then value else [value] ' % schema._name, - ), - this.functionName(schema._name), - this.nestInParents( - schema._name, - schema._parents, - ' "%s"+: if std.isArray(value) then value else [value] ' % schema._name, - ), - ], - - named(name, object):: - ||| - "%s"+: %s, - ||| % [ - name, - object, - ], - - toObject(object):: - '{ %s }' % object, - - newFunction(parents):: - '{\n %s \n}' % - this.nestInParents( - 'new', - parents, - ||| - new(name): - self.withApiVersion() - + self.withKind() - + self.metadata.withName(name), - |||, - ), -} - -// vim: foldmethod=indent diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/.gitignore b/vendor/github.com/crdsonnet/validate-libsonnet/.gitignore deleted file mode 100644 index f9bf6ba..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -jsonnetfile.lock.json -vendor diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/LICENSE b/vendor/github.com/crdsonnet/validate-libsonnet/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/Makefile b/vendor/github.com/crdsonnet/validate-libsonnet/Makefile deleted file mode 100644 index 51cf27c..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/Makefile +++ /dev/null @@ -1,3 +0,0 @@ -README.md: - jsonnet -J vendor -S -c -m . \ - --exec "(import 'doc-util/main.libsonnet').render(import 'main.libsonnet')" diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/README.md b/vendor/github.com/crdsonnet/validate-libsonnet/README.md deleted file mode 100644 index f10f6cd..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/README.md +++ /dev/null @@ -1,212 +0,0 @@ -# validate-libsonnet - -Type checking is a common grievance in the jsonnet eco-system, this library is an -aid to validate function parameters and other values. - -Here's a comprehensive example validating the function arguments against the -arguments documented by docsonnet: - -```jsonnet -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet'; - -{ - '#func':: - d.func.new( - 'sample function', - args=[ - d.arg('num', d.T.number), - d.arg('str', d.T.string), - d.arg('enum', d.T.string, enums=['valid', 'values']), - ], - ), - func(num, str, enum):: - assert validate.checkParamsFromDocstring( - [num, str, enum], - self['#func'], - ); - {/* do something here */ }, - - return: self.func(100, 'this is a string', 'valid'), -} - -``` - -A failure output would look like this: - -``` -TRACE: vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter enum is invalid: - Value "invalid" MUST match schema: - { - "enum": [ - "valid", - "values" - ], - "type": "string" - } - Parameter str is invalid: - Value 20 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - fromdocstring.jsonnet:(15:5)-(19:31) - fromdocstring.jsonnet:21:11-40 object - Field "return" - During manifestation - - -``` - - -## Install - -``` -jb install github.com/crdsonnet/validate-libsonnet@master -``` - -## Usage - -```jsonnet -local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet' -``` - -## Index - -* [`fn checkParameters(checks)`](#fn-checkparameters) -* [`fn checkParamsFromDocstring(params, docstring)`](#fn-checkparamsfromdocstring) -* [`fn getChecksFromDocstring(params, docstring)`](#fn-getchecksfromdocstring) -* [`fn schemaCheck(param, schema)`](#fn-schemacheck) - -## Fields - -### fn checkParameters - -```ts -checkParameters(checks) -``` - -`checkParameters` validates parameters against their `checks`. - -```jsonnet -local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet'; - -local func(arg) = - assert validate.checkParameters({ - arg: std.isString(arg), - }); - {/* do something here */ }; - -func('this is a string') - -``` - -A failure output would look like this: - -``` -TRACE: vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter enum is invalid: - Value "invalid" MUST match schema: - { - "enum": [ - "valid", - "values" - ], - "type": "string" - } - Parameter str is invalid: - Value 20 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - fromdocstring.jsonnet:(15:5)-(19:31) - fromdocstring.jsonnet:21:11-40 object - Field "return" - During manifestation - - -``` - - -### fn checkParamsFromDocstring - -```ts -checkParamsFromDocstring(params, docstring) -``` - -`checkParamsFromDocstring` validates `params` against a docsonnet `docstring` object. - -```jsonnet -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet'; - -{ - '#func':: - d.func.new( - 'sample function', - args=[ - d.arg('num', d.T.number), - d.arg('str', d.T.string), - d.arg('enum', d.T.string, enums=['valid', 'values']), - ], - ), - func(num, str, enum):: - assert validate.checkParamsFromDocstring( - [num, str, enum], - self['#func'], - ); - {/* do something here */ }, - - return: self.func(100, 'this is a string', 'valid'), -} - -``` - -A failure output would look like this: - -``` -TRACE: vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter enum is invalid: - Value "invalid" MUST match schema: - { - "enum": [ - "valid", - "values" - ], - "type": "string" - } - Parameter str is invalid: - Value 20 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - fromdocstring.jsonnet:(15:5)-(19:31) - fromdocstring.jsonnet:21:11-40 object - Field "return" - During manifestation - - -``` - - -### fn getChecksFromDocstring - -```ts -getChecksFromDocstring(params, docstring) -``` - -`getChecksFromDocstring` returns checks for `params` derived from a docsonnet `docstring` object. - -### fn schemaCheck - -```ts -schemaCheck(param, schema) -``` - -`schemaCheck` validates `param` against a JSON `schema`. Note that this function does not resolve "$ref" and recursion. diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet deleted file mode 100644 index fc1ca7a..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet +++ /dev/null @@ -1,22 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local validate = import 'validate-libsonnet/main.libsonnet'; - -{ - '#func':: - d.func.new( - 'sample function', - args=[ - d.arg('num', d.T.number), - d.arg('str', d.T.string), - d.arg('enum', d.T.string, enums=['valid', 'values']), - ], - ), - func(num, str, enum):: - assert validate.checkParamsFromDocstring( - [num, str, enum], - self['#func'], - ); - {/* do something here */ }, - - return: self.func(100, 'this is a string', 'valid'), -} diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet.output b/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet.output deleted file mode 100644 index 1d20b38..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet.output +++ /dev/null @@ -1,22 +0,0 @@ -TRACE: vendor/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter enum is invalid: - Value "invalid" MUST match schema: - { - "enum": [ - "valid", - "values" - ], - "type": "string" - } - Parameter str is invalid: - Value 20 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - fromdocstring.jsonnet:(15:5)-(19:31) - fromdocstring.jsonnet:21:11-40 object - Field "return" - During manifestation - diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/jsonnetfile.json b/vendor/github.com/crdsonnet/validate-libsonnet/example/jsonnetfile.json deleted file mode 100644 index 8f39f0c..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/jsonnetfile.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/jsonnet-libs/docsonnet.git", - "subdir": "doc-util" - } - }, - "version": "master" - }, - { - "source": { - "local": { - "directory": ".." - } - }, - "version": "" - } - ], - "legacyImports": true -} diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/samplechecks.jsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/example/samplechecks.jsonnet deleted file mode 100644 index cd1f13a..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/samplechecks.jsonnet +++ /dev/null @@ -1,9 +0,0 @@ -// Examples checks: - -local customCheck(value) = - std.member(['a', 'b'], value); - -local stringMaxLengthCheck(value) = - local schema = { type: 'string', maxLength: 1 }; - params.schemaCheck(value, schema); - diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet deleted file mode 100644 index c8a6d55..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet +++ /dev/null @@ -1,9 +0,0 @@ -local validate = import 'validate-libsonnet/main.libsonnet'; - -local func(arg) = - assert validate.checkParameters({ - arg: std.isString(arg), - }); - {/* do something here */ }; - -func('this is a string') diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet.output b/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet.output deleted file mode 100644 index 2da2f5b..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet.output +++ /dev/null @@ -1,8 +0,0 @@ -TRACE: vendor/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter arg is invalid. -RUNTIME ERROR: Assertion failed - simple.jsonnet:(4:3)-(7:29) - simple.jsonnet:9:1-9 $ - During evaluation - diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/jsonnetfile.json b/vendor/github.com/crdsonnet/validate-libsonnet/jsonnetfile.json deleted file mode 100644 index a8232b3..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/jsonnetfile.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/jsonnet-libs/docsonnet.git", - "subdir": "doc-util" - } - }, - "version": "master" - } - ], - "legacyImports": true -} diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet deleted file mode 100644 index 929e631..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet +++ /dev/null @@ -1,178 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - local root = self, - - '#': - d.package.new( - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ||| - Type checking is a common grievance in the jsonnet eco-system, this library is an - aid to validate function parameters and other values. - - Here's a comprehensive example validating the function arguments against the - arguments documented by docsonnet: - - ```jsonnet - %s - ``` - - A failure output would look like this: - - ``` - %s - ``` - ||| % [ - std.strReplace( - importstr 'example/fromdocstring.jsonnet', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - std.strReplace( - importstr 'example/fromdocstring.jsonnet.output', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - ], - std.thisFile, - ) - + d.package.withUsageTemplate( - "local validate = import '%(import)s'" - ), - - '#checkParameters': d.fn( - ||| - `checkParameters` validates parameters against their `checks`. - - ```jsonnet - %s - ``` - - A failure output would look like this: - - ``` - %s - ``` - ||| % [ - std.strReplace( - importstr 'example/simple.jsonnet', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - std.strReplace( - importstr 'example/fromdocstring.jsonnet.output', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - ], - args=[d.arg('checks', d.T.object)], - ), - checkParameters(checks): - local failures = [ - 'Parameter %s is invalid%s' % [ - n, - (if (std.isArray(checks[n])) - then ':' + std.join('\n ', checks[n][1:]) - else '.'), - ] - for n in std.objectFields(checks) - if (std.isArray(checks[n]) && !checks[n][0]) - || (std.isBoolean(checks[n]) && !checks[n]) - ]; - local tests = std.all([ - if std.isArray(checks[n]) - then checks[n][0] - else checks[n] - for n in std.objectFields(checks) - if (std.isArray(checks[n]) && !checks[n][0]) - || (std.isBoolean(checks[n]) && !checks[n]) - ]); - if tests - then true - else - std.trace( - std.join( - '\n ', - ['\nInvalid parameters:'] - + failures - ), - false - ), - - '#checkParamsFromDocstring': d.fn( - ||| - `checkParamsFromDocstring` validates `params` against a docsonnet `docstring` object. - - ```jsonnet - %s - ``` - - A failure output would look like this: - - ``` - %s - ``` - ||| % [ - std.strReplace( - importstr 'example/fromdocstring.jsonnet', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - std.strReplace( - importstr 'example/fromdocstring.jsonnet.output', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - ], - args=[ - d.arg('params', d.T.array), - d.arg('docstring', d.T.object), - ], - ), - checkParamsFromDocstring(params, docstring): - root.checkParameters( - root.getChecksFromDocstring(params, docstring) - ), - - '#getChecksFromDocstring': d.fn( - '`getChecksFromDocstring` returns checks for `params` derived from a docsonnet `docstring` object.', - args=[ - d.arg('params', d.T.array), - d.arg('docstring', d.T.object), - ], - ), - getChecksFromDocstring(params, docstring): - local args = docstring['function'].args; - assert std.length(args) == std.length(params) - : 'checkFromDocstring: expect equal number of args as params'; - - local hasEnum(arg) = 'enums' in arg && std.isArray(arg.enums); - { - [args[i].name]: - root.schemaCheck( - params[i], - { - type: args[i].type, - [if hasEnum(args[i]) then 'enum']: args[i].enums, - } - ) - for i in std.range(0, std.length(params) - 1) - }, - - '#schemaCheck': d.fn( - '`schemaCheck` validates `param` against a JSON `schema`. Note that this function does not resolve "$ref" and recursion.', - args=[ - d.arg('param', d.T.any), - d.arg('schema', d.T.object), - ], - ), - schemaCheck(param, schema): - local v = import './validate.libsonnet'; - local indent = ' '; - [ - v.validate(param, schema), - '\n%sValue %s MUST match schema:' % [indent, std.manifestJson(param)], - indent + std.manifestJsonEx(schema, ' ', '\n ' + indent), - ], -} diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/validate.libsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/validate.libsonnet deleted file mode 100644 index 3b7bdeb..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/validate.libsonnet +++ /dev/null @@ -1,327 +0,0 @@ -{ - local root = self, - - validate(object, schema):: - if std.isBoolean(schema) - then schema - else if schema == {} - then true - else root.process( - object, - schema, - root.genericTestCases - ), - - process(object, schema, testcases): - std.all([ - testcases[keyword](object, schema) - for keyword in std.objectFields(testcases) - if keyword in schema - ]), - - types: { - boolean(object, schema): - std.isBoolean(object), - - 'null'(object, schema): - std.type(object) == 'null', - - string(object, schema):: - // foldStart - if !std.isString(object) - then false - else root.process( - object, - schema, - root.typeTestCases.string - ), - // foldEnd - - number(object, schema):: - // foldStart - if !std.isNumber(object) - then false - else root.process( - object, - schema, - root.typeTestCases.number - ), - // foldEnd - - integer(object, schema):: - // foldStart - if !std.isNumber(object) - && std.mod(object, 1) != 0 - then false - else root.process( - object, - schema, - root.typeTestCases.number - ), - // foldEnd - - object(object, schema):: - // foldStart - if !std.isObject(object) - then false - else root.process( - object, - schema, - root.typeTestCases.object - ), - // foldEnd - - array(object, schema):: - // foldStart - if !std.isArray(object) - then false - else root.process( - object, - schema, - root.typeTestCases.array - ), - // foldEnd - }, - - notImplemented(key, schema): - std.trace('JSON Schema attribute `%s` not implemented.' % key, true), - - genericTestCases: { - enum(object, schema): - std.member(schema.enum, object), - - const(object, schema): - object == schema.const, - - not(object, schema): - !root.validate(object, schema.not), - - allOf(object, schema): - // foldStart - std.all([ - root.validate(object, s) - for s in schema.allOf - ]), - // foldEnd - - anyOf(object, schema): - // foldStart - std.any([ - root.validate(object, s) - for s in schema.anyOf - ]), - // foldEnd - - oneOf(object, schema): - // foldStart - std.length([ - true - for s in schema.oneOf - if root.validate(object, s) - ]) == 1, - // foldEnd - - 'if'(object, schema): - // foldStart - if root.validate( - object, - std.mergePatch( - schema { 'if': true, 'then': true }, - schema['if'] - ) - ) - then - if 'then' in schema - then - root.validate( - object, - std.mergePatch( - schema { 'if': true, 'then': true }, - schema['then'] - ) - ) - else true - else - if 'else' in schema - then - root.validate( - object, - std.mergePatch( - schema { 'if': true, 'then': true }, - schema['else'] - ) - ) - else true, - // foldEnd - - type(object, schema): - // foldStart - if std.isBoolean(schema.type) - then object != null - - else if std.isArray(schema.type) - then std.any([ - root.types[t](object, schema) - for t in schema.type - ]) - - else root.types[schema.type](object, schema), - // foldEnd - }, - - typeTestCases: { - string: { - // foldStart - minLength(object, schema): - std.length(object) >= schema.minLength, - - maxLength(object, schema): - std.length(object) <= schema.maxLength, - - pattern(object, schema): - root.notImplemented('pattern', schema), - - // vocabulary specific - //format(object, schema): - // root.notImplemented('format', schema), - }, // foldEnd - - number: { - // foldStart - multipleOf(object, schema): std.mod(object, schema.multipleOf) == 0, - minimum(object, schema): object >= schema.minimum, - maximum(object, schema): object <= schema.maximum, - - exclusiveMinimum(object, schema): - if std.isBoolean(schema.exclusiveMinimum) // Draft 4 - then - if 'minimum' in schema - then - if schema.exclusiveMinimum - then object > schema.minimum - else object >= schema.minimum - else true // invalid schema doesn't mean invalid object - else object > schema.exclusiveMinimum, - - exclusiveMaximum(object, schema): - if std.isBoolean(schema.exclusiveMaximum) // Draft 4 - then - if 'maximum' in schema - then - if schema.exclusiveMaximum - then object > schema.maximum - else object >= schema.maximum - else true // invalid schema doesn't mean invalid object - else object > schema.exclusiveMaximum, - }, // foldEnd - - object: { - // foldStart - patternProperties(object, schema): - root.notImplemented('patternProperties', schema), - dependentRequired(object, schema): - root.notImplemented('dependentRequired', schema), - unevaluatedProperties(object, schema): - root.notImplemented('unevaluatedProperties', schema), - additionalProperties(object, schema): - root.notImplemented('additionalProperties', schema), - - properties(object, schema): - std.all([ - root.validate(object[property], schema.properties[property]) - for property in std.objectFields(schema.properties) - if property in object - ]), - - required(object, schema): - std.all([ - std.member(std.objectFields(object), property) - for property in schema.required - ]), - - propertyNames(object, schema): - std.all([ - self.string(property, schema.propertyNames) - for property in std.objectFields(schema) - ]), - - minProperties(object, schema): - std.count(std.objectFields(object)) >= schema.minProperties, - - maxProperties(object, schema): - std.count(std.objectFields(object)) <= schema.maxProperties, - - }, // foldEnd - - array: { - // foldStart - minItems(object, schema): - std.length(object) >= schema.minItems, - - maxItems(object, schema): - std.length(object) <= schema.maxItems, - - uniqueItems(object, schema): - local f = function(x) std.md5(std.manifestJson(x)); - if schema.uniqueItems - then std.set(object, f) == std.sort(object, f) - else true, - - prefixItems(object, schema): - if std.length(schema.prefixItems) > 0 - then - local lengthCheck = - if 'items' in schema - && std.isBoolean(schema.items) - && !schema.items - then std.length(object) == std.length(schema.prefixItems) - else std.length(object) >= std.length(schema.prefixItems); - - if !lengthCheck - then false - else - std.all([ - root.validate(object[i], schema.prefixItems[i]) - for i in std.range(0, std.length(schema.prefixItems) - 1) - ]) - else true, - - items(object, schema): - if std.isBoolean(schema.items) - then true // only valid in the context of prefixItems - else - if std.length(object) == 0 - then true // validated by prefixItems and min/maxLength - else - local count = - if 'prefixItems' in schema - then std.length(schema.prefixItems) - else 0; - std.all([ - root.validate(item, schema.items) - for item in object[count:] - ]), - - contains(object, schema): - local validated = [ - true - for item in object - if root.validate(item, schema.contains) - ]; - std.any(validated) - && std.all([ - if 'minContains' in schema - then std.length(validated) >= schema.minContains - else true, - if 'maxContains' in schema - then std.length(validated) <= schema.maxContains - else true, - ]), - - unevaluatedItems(object, schema): - root.notImplemented('unevaluatedItems', schema), - }, // foldEnd - }, -} - -// vim: foldmethod=marker foldmarker=foldStart,foldEnd foldlevel=0 diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json b/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json index 6b1bb91..bf3d00f 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json @@ -4,7 +4,7 @@ "source": { "git": { "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "gen/grafonnet-v10.0.0" + "subdir": "gen/grafonnet-v10.2.0" } }, "version": "main" diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet index 6da9f4e..c271fd6 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet @@ -1 +1 @@ -import 'github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet' +import 'github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/main.libsonnet' diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs.libsonnet deleted file mode 100644 index f0347b0..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs.libsonnet +++ /dev/null @@ -1,3 +0,0 @@ -local grafonnet = import 'github.com/grafana/grafonnet/grafonnet-base/main.libsonnet'; -local main = import './main.libsonnet'; -grafonnet.docs(main) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/README.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/README.md deleted file mode 100644 index de1f82e..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# grafonnet - -Jsonnet library for rendering Grafana resources - -## Install - -``` -jb install github.com/grafana/grafonnet/gen/grafonnet-v10.0.0@main -``` - -## Usage - -```jsonnet -local grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet" -``` - -## Subpackages - -* [dashboard](grafonnet/dashboard/index.md) -* [librarypanel](grafonnet/librarypanel.md) -* [panel](grafonnet/panel/index.md) -* [playlist](grafonnet/playlist.md) -* [preferences](grafonnet/preferences.md) -* [publicdashboard](grafonnet/publicdashboard.md) -* [query](grafonnet/query/index.md) -* [serviceaccount](grafonnet/serviceaccount.md) -* [team](grafonnet/team.md) -* [util](grafonnet/util.md) - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/link.md deleted file mode 100644 index 1c82a56..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/link.md +++ /dev/null @@ -1,134 +0,0 @@ -# link - - - -## Index - -* [`obj dashboards`](#obj-dashboards) - * [`fn new(title, tags)`](#fn-dashboardsnew) - * [`obj options`](#obj-dashboardsoptions) - * [`fn withAsDropdown(value=false)`](#fn-dashboardsoptionswithasdropdown) - * [`fn withIncludeVars(value=false)`](#fn-dashboardsoptionswithincludevars) - * [`fn withKeepTime(value=false)`](#fn-dashboardsoptionswithkeeptime) - * [`fn withTargetBlank(value=false)`](#fn-dashboardsoptionswithtargetblank) -* [`obj link`](#obj-link) - * [`fn new(title, url)`](#fn-linknew) - * [`fn withIcon(value)`](#fn-linkwithicon) - * [`fn withTooltip(value)`](#fn-linkwithtooltip) - * [`obj options`](#obj-linkoptions) - * [`fn withAsDropdown(value=false)`](#fn-linkoptionswithasdropdown) - * [`fn withIncludeVars(value=false)`](#fn-linkoptionswithincludevars) - * [`fn withKeepTime(value=false)`](#fn-linkoptionswithkeeptime) - * [`fn withTargetBlank(value=false)`](#fn-linkoptionswithtargetblank) - -## Fields - -### obj dashboards - - -#### fn dashboards.new - -```ts -new(title, tags) -``` - -Create links to dashboards based on `tags`. - - -#### obj dashboards.options - - -##### fn dashboards.options.withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -##### fn dashboards.options.withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -##### fn dashboards.options.withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -##### fn dashboards.options.withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### obj link - - -#### fn link.new - -```ts -new(title, url) -``` - -Create link to an arbitrary URL. - - -#### fn link.withIcon - -```ts -withIcon(value) -``` - - - -#### fn link.withTooltip - -```ts -withTooltip(value) -``` - - - -#### obj link.options - - -##### fn link.options.withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -##### fn link.options.withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -##### fn link.options.withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -##### fn link.options.withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/index.md deleted file mode 100644 index 3eb7d60..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/index.md +++ /dev/null @@ -1,497 +0,0 @@ -# alertGroups - -grafonnet.panel.alertGroups - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withAlertmanager(value)`](#fn-optionswithalertmanager) - * [`fn withExpandAll(value)`](#fn-optionswithexpandall) - * [`fn withLabels(value)`](#fn-optionswithlabels) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new alertGroups panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withAlertmanager - -```ts -withAlertmanager(value) -``` - -Name of the alertmanager used as a source for alerts - -#### fn options.withExpandAll - -```ts -withExpandAll(value) -``` - -Expand all alert groups by default - -#### fn options.withLabels - -```ts -withLabels(value) -``` - -Comma-separated list of values used to filter alert results - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/index.md deleted file mode 100644 index b5d34cf..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/index.md +++ /dev/null @@ -1,569 +0,0 @@ -# annotationsList - -grafonnet.panel.annotationsList - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withLimit(value=10)`](#fn-optionswithlimit) - * [`fn withNavigateAfter(value="10m")`](#fn-optionswithnavigateafter) - * [`fn withNavigateBefore(value="10m")`](#fn-optionswithnavigatebefore) - * [`fn withNavigateToPanel(value=true)`](#fn-optionswithnavigatetopanel) - * [`fn withOnlyFromThisDashboard(value=false)`](#fn-optionswithonlyfromthisdashboard) - * [`fn withOnlyInTimeRange(value=false)`](#fn-optionswithonlyintimerange) - * [`fn withShowTags(value=true)`](#fn-optionswithshowtags) - * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) - * [`fn withShowUser(value=true)`](#fn-optionswithshowuser) - * [`fn withTags(value)`](#fn-optionswithtags) - * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new annotationsList panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withLimit - -```ts -withLimit(value=10) -``` - - - -#### fn options.withNavigateAfter - -```ts -withNavigateAfter(value="10m") -``` - - - -#### fn options.withNavigateBefore - -```ts -withNavigateBefore(value="10m") -``` - - - -#### fn options.withNavigateToPanel - -```ts -withNavigateToPanel(value=true) -``` - - - -#### fn options.withOnlyFromThisDashboard - -```ts -withOnlyFromThisDashboard(value=false) -``` - - - -#### fn options.withOnlyInTimeRange - -```ts -withOnlyInTimeRange(value=false) -``` - - - -#### fn options.withShowTags - -```ts -withShowTags(value=true) -``` - - - -#### fn options.withShowTime - -```ts -withShowTime(value=true) -``` - - - -#### fn options.withShowUser - -```ts -withShowUser(value=true) -``` - - - -#### fn options.withTags - -```ts -withTags(value) -``` - - - -#### fn options.withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/index.md deleted file mode 100644 index e3a21c3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/index.md +++ /dev/null @@ -1,1030 +0,0 @@ -# barChart - -grafonnet.panel.barChart - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withAxisCenteredZero(value)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) - * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) - * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) - * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withBarRadius(value=0)`](#fn-optionswithbarradius) - * [`fn withBarWidth(value=0.97)`](#fn-optionswithbarwidth) - * [`fn withColorByField(value)`](#fn-optionswithcolorbyfield) - * [`fn withFullHighlight(value=false)`](#fn-optionswithfullhighlight) - * [`fn withGroupWidth(value=0.7)`](#fn-optionswithgroupwidth) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withStacking(value)`](#fn-optionswithstacking) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`fn withXField(value)`](#fn-optionswithxfield) - * [`fn withXTickLabelMaxLength(value)`](#fn-optionswithxticklabelmaxlength) - * [`fn withXTickLabelRotation(value=0)`](#fn-optionswithxticklabelrotation) - * [`fn withXTickLabelSpacing(value=0)`](#fn-optionswithxticklabelspacing) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new barChart panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -###### fn fieldConfig.defaults.custom.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -###### fn fieldConfig.defaults.custom.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value=80) -``` - -Controls the fill opacity of the bars. - -###### fn fieldConfig.defaults.custom.withGradientMode - -```ts -withGradientMode(value) -``` - -Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. -Gradient appearance is influenced by the Fill opacity setting. - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value=1) -``` - -Controls line width of the bars. - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyle - -```ts -withThresholdsStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin - -```ts -withThresholdsStyleMixin(value) -``` - -TODO docs - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -###### obj fieldConfig.defaults.custom.thresholdsStyle - - -####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "off", "line", "dashed", "area", "line+area", "dashed+area", "series" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withBarRadius - -```ts -withBarRadius(value=0) -``` - -Controls the radius of each bar. - -#### fn options.withBarWidth - -```ts -withBarWidth(value=0.97) -``` - -Controls the width of bars. 1 = Max width, 0 = Min width. - -#### fn options.withColorByField - -```ts -withColorByField(value) -``` - -Use the color value for a sibling field to color each bar value. - -#### fn options.withFullHighlight - -```ts -withFullHighlight(value=false) -``` - -Enables mode which highlights the entire bar area and shows tooltip when cursor -hovers over highlighted area - -#### fn options.withGroupWidth - -```ts -withGroupWidth(value=0.7) -``` - -Controls the width of groups. 1 = max with, 0 = min width. - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -Controls the orientation of the bar chart, either vertical or horizontal. - -#### fn options.withShowValue - -```ts -withShowValue(value) -``` - -This controls whether values are shown on top or to the left of bars. - -#### fn options.withStacking - -```ts -withStacking(value) -``` - -Controls whether bars are stacked or not, either normally or in percent mode. - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### fn options.withXField - -```ts -withXField(value) -``` - -Manually select which field from the dataset to represent the x field. - -#### fn options.withXTickLabelMaxLength - -```ts -withXTickLabelMaxLength(value) -``` - -Sets the max length that a label can have before it is truncated. - -#### fn options.withXTickLabelRotation - -```ts -withXTickLabelRotation(value=0) -``` - -Controls the rotation of the x axis labels. - -#### fn options.withXTickLabelSpacing - -```ts -withXTickLabelSpacing(value=0) -``` - -Controls the spacing between x axis labels. -negative values indicate backwards skipping behavior - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/index.md deleted file mode 100644 index 7b9a4ed..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/index.md +++ /dev/null @@ -1,638 +0,0 @@ -# barGauge - -grafonnet.panel.barGauge - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withDisplayMode(value)`](#fn-optionswithdisplaymode) - * [`fn withMinVizHeight(value=10)`](#fn-optionswithminvizheight) - * [`fn withMinVizWidth(value=0)`](#fn-optionswithminvizwidth) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) - * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) - * [`fn withShowUnfilled(value=true)`](#fn-optionswithshowunfilled) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`fn withValueMode(value)`](#fn-optionswithvaluemode) - * [`obj reduceOptions`](#obj-optionsreduceoptions) - * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) - * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) - * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) - * [`fn withValues(value)`](#fn-optionsreduceoptionswithvalues) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new barGauge panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withDisplayMode - -```ts -withDisplayMode(value) -``` - -Enum expressing the possible display modes -for the bar gauge component of Grafana UI - -Accepted values for `value` are "basic", "lcd", "gradient" - -#### fn options.withMinVizHeight - -```ts -withMinVizHeight(value=10) -``` - - - -#### fn options.withMinVizWidth - -```ts -withMinVizWidth(value=0) -``` - - - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "vertical", "horizontal" - -#### fn options.withReduceOptions - -```ts -withReduceOptions(value) -``` - -TODO docs - -#### fn options.withReduceOptionsMixin - -```ts -withReduceOptionsMixin(value) -``` - -TODO docs - -#### fn options.withShowUnfilled - -```ts -withShowUnfilled(value=true) -``` - - - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### fn options.withValueMode - -```ts -withValueMode(value) -``` - -Allows for the table cell gauge display type to set the gauge mode. - -Accepted values for `value` are "color", "text", "hidden" - -#### obj options.reduceOptions - - -##### fn options.reduceOptions.withCalcs - -```ts -withCalcs(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withFields - -```ts -withFields(value) -``` - -Which fields to show. By default this is only numeric fields - -##### fn options.reduceOptions.withLimit - -```ts -withLimit(value) -``` - -if showing all values limit - -##### fn options.reduceOptions.withValues - -```ts -withValues(value) -``` - -If true show each row value - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/index.md deleted file mode 100644 index 7012b2f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/index.md +++ /dev/null @@ -1,466 +0,0 @@ -# candlestick - -grafonnet.panel.candlestick - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new candlestick panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/index.md deleted file mode 100644 index 6966e65..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/index.md +++ /dev/null @@ -1,466 +0,0 @@ -# canvas - -grafonnet.panel.canvas - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new canvas panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/index.md deleted file mode 100644 index 0d12686..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/index.md +++ /dev/null @@ -1,569 +0,0 @@ -# dashboardList - -grafonnet.panel.dashboardList - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withFolderId(value)`](#fn-optionswithfolderid) - * [`fn withIncludeVars(value=false)`](#fn-optionswithincludevars) - * [`fn withKeepTime(value=false)`](#fn-optionswithkeeptime) - * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) - * [`fn withQuery(value="")`](#fn-optionswithquery) - * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) - * [`fn withShowRecentlyViewed(value=false)`](#fn-optionswithshowrecentlyviewed) - * [`fn withShowSearch(value=false)`](#fn-optionswithshowsearch) - * [`fn withShowStarred(value=true)`](#fn-optionswithshowstarred) - * [`fn withTags(value)`](#fn-optionswithtags) - * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new dashboardList panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withFolderId - -```ts -withFolderId(value) -``` - - - -#### fn options.withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -#### fn options.withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -#### fn options.withMaxItems - -```ts -withMaxItems(value=10) -``` - - - -#### fn options.withQuery - -```ts -withQuery(value="") -``` - - - -#### fn options.withShowHeadings - -```ts -withShowHeadings(value=true) -``` - - - -#### fn options.withShowRecentlyViewed - -```ts -withShowRecentlyViewed(value=false) -``` - - - -#### fn options.withShowSearch - -```ts -withShowSearch(value=false) -``` - - - -#### fn options.withShowStarred - -```ts -withShowStarred(value=true) -``` - - - -#### fn options.withTags - -```ts -withTags(value) -``` - - - -#### fn options.withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/index.md deleted file mode 100644 index 7cc60ea..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/index.md +++ /dev/null @@ -1,479 +0,0 @@ -# datagrid - -grafonnet.panel.datagrid - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withSelectedSeries(value=0)`](#fn-optionswithselectedseries) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new datagrid panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withSelectedSeries - -```ts -withSelectedSeries(value=0) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/index.md deleted file mode 100644 index 4fff5d9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/index.md +++ /dev/null @@ -1,530 +0,0 @@ -# debug - -grafonnet.panel.debug - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withCounters(value)`](#fn-optionswithcounters) - * [`fn withCountersMixin(value)`](#fn-optionswithcountersmixin) - * [`fn withMode(value)`](#fn-optionswithmode) - * [`obj counters`](#obj-optionscounters) - * [`fn withDataChanged(value)`](#fn-optionscounterswithdatachanged) - * [`fn withRender(value)`](#fn-optionscounterswithrender) - * [`fn withSchemaChanged(value)`](#fn-optionscounterswithschemachanged) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new debug panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withCounters - -```ts -withCounters(value) -``` - - - -#### fn options.withCountersMixin - -```ts -withCountersMixin(value) -``` - - - -#### fn options.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "render", "events", "cursor", "State", "ThrowError" - -#### obj options.counters - - -##### fn options.counters.withDataChanged - -```ts -withDataChanged(value) -``` - - - -##### fn options.counters.withRender - -```ts -withRender(value) -``` - - - -##### fn options.counters.withSchemaChanged - -```ts -withSchemaChanged(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/index.md deleted file mode 100644 index 0c3b383..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/index.md +++ /dev/null @@ -1,606 +0,0 @@ -# gauge - -grafonnet.panel.gauge - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) - * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) - * [`fn withShowThresholdLabels(value=false)`](#fn-optionswithshowthresholdlabels) - * [`fn withShowThresholdMarkers(value=true)`](#fn-optionswithshowthresholdmarkers) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`obj reduceOptions`](#obj-optionsreduceoptions) - * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) - * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) - * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) - * [`fn withValues(value)`](#fn-optionsreduceoptionswithvalues) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new gauge panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "vertical", "horizontal" - -#### fn options.withReduceOptions - -```ts -withReduceOptions(value) -``` - -TODO docs - -#### fn options.withReduceOptionsMixin - -```ts -withReduceOptionsMixin(value) -``` - -TODO docs - -#### fn options.withShowThresholdLabels - -```ts -withShowThresholdLabels(value=false) -``` - - - -#### fn options.withShowThresholdMarkers - -```ts -withShowThresholdMarkers(value=true) -``` - - - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### obj options.reduceOptions - - -##### fn options.reduceOptions.withCalcs - -```ts -withCalcs(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withFields - -```ts -withFields(value) -``` - -Which fields to show. By default this is only numeric fields - -##### fn options.reduceOptions.withLimit - -```ts -withLimit(value) -``` - -if showing all values limit - -##### fn options.reduceOptions.withValues - -```ts -withValues(value) -``` - -If true show each row value - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/index.md deleted file mode 100644 index 2da7755..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/index.md +++ /dev/null @@ -1,1030 +0,0 @@ -# geomap - -grafonnet.panel.geomap - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withBasemap(value)`](#fn-optionswithbasemap) - * [`fn withBasemapMixin(value)`](#fn-optionswithbasemapmixin) - * [`fn withControls(value)`](#fn-optionswithcontrols) - * [`fn withControlsMixin(value)`](#fn-optionswithcontrolsmixin) - * [`fn withLayers(value)`](#fn-optionswithlayers) - * [`fn withLayersMixin(value)`](#fn-optionswithlayersmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`fn withView(value)`](#fn-optionswithview) - * [`fn withViewMixin(value)`](#fn-optionswithviewmixin) - * [`obj basemap`](#obj-optionsbasemap) - * [`fn withConfig(value)`](#fn-optionsbasemapwithconfig) - * [`fn withFilterData(value)`](#fn-optionsbasemapwithfilterdata) - * [`fn withLocation(value)`](#fn-optionsbasemapwithlocation) - * [`fn withLocationMixin(value)`](#fn-optionsbasemapwithlocationmixin) - * [`fn withName(value)`](#fn-optionsbasemapwithname) - * [`fn withOpacity(value)`](#fn-optionsbasemapwithopacity) - * [`fn withTooltip(value)`](#fn-optionsbasemapwithtooltip) - * [`fn withType(value)`](#fn-optionsbasemapwithtype) - * [`obj location`](#obj-optionsbasemaplocation) - * [`fn withGazetteer(value)`](#fn-optionsbasemaplocationwithgazetteer) - * [`fn withGeohash(value)`](#fn-optionsbasemaplocationwithgeohash) - * [`fn withLatitude(value)`](#fn-optionsbasemaplocationwithlatitude) - * [`fn withLongitude(value)`](#fn-optionsbasemaplocationwithlongitude) - * [`fn withLookup(value)`](#fn-optionsbasemaplocationwithlookup) - * [`fn withMode(value)`](#fn-optionsbasemaplocationwithmode) - * [`fn withWkt(value)`](#fn-optionsbasemaplocationwithwkt) - * [`obj controls`](#obj-optionscontrols) - * [`fn withMouseWheelZoom(value)`](#fn-optionscontrolswithmousewheelzoom) - * [`fn withShowAttribution(value)`](#fn-optionscontrolswithshowattribution) - * [`fn withShowDebug(value)`](#fn-optionscontrolswithshowdebug) - * [`fn withShowMeasure(value)`](#fn-optionscontrolswithshowmeasure) - * [`fn withShowScale(value)`](#fn-optionscontrolswithshowscale) - * [`fn withShowZoom(value)`](#fn-optionscontrolswithshowzoom) - * [`obj layers`](#obj-optionslayers) - * [`fn withConfig(value)`](#fn-optionslayerswithconfig) - * [`fn withFilterData(value)`](#fn-optionslayerswithfilterdata) - * [`fn withLocation(value)`](#fn-optionslayerswithlocation) - * [`fn withLocationMixin(value)`](#fn-optionslayerswithlocationmixin) - * [`fn withName(value)`](#fn-optionslayerswithname) - * [`fn withOpacity(value)`](#fn-optionslayerswithopacity) - * [`fn withTooltip(value)`](#fn-optionslayerswithtooltip) - * [`fn withType(value)`](#fn-optionslayerswithtype) - * [`obj location`](#obj-optionslayerslocation) - * [`fn withGazetteer(value)`](#fn-optionslayerslocationwithgazetteer) - * [`fn withGeohash(value)`](#fn-optionslayerslocationwithgeohash) - * [`fn withLatitude(value)`](#fn-optionslayerslocationwithlatitude) - * [`fn withLongitude(value)`](#fn-optionslayerslocationwithlongitude) - * [`fn withLookup(value)`](#fn-optionslayerslocationwithlookup) - * [`fn withMode(value)`](#fn-optionslayerslocationwithmode) - * [`fn withWkt(value)`](#fn-optionslayerslocationwithwkt) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`obj view`](#obj-optionsview) - * [`fn withAllLayers(value=true)`](#fn-optionsviewwithalllayers) - * [`fn withId(value="zero")`](#fn-optionsviewwithid) - * [`fn withLastOnly(value)`](#fn-optionsviewwithlastonly) - * [`fn withLat(value=0)`](#fn-optionsviewwithlat) - * [`fn withLayer(value)`](#fn-optionsviewwithlayer) - * [`fn withLon(value=0)`](#fn-optionsviewwithlon) - * [`fn withMaxZoom(value)`](#fn-optionsviewwithmaxzoom) - * [`fn withMinZoom(value)`](#fn-optionsviewwithminzoom) - * [`fn withPadding(value)`](#fn-optionsviewwithpadding) - * [`fn withShared(value)`](#fn-optionsviewwithshared) - * [`fn withZoom(value=1)`](#fn-optionsviewwithzoom) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new geomap panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withBasemap - -```ts -withBasemap(value) -``` - - - -#### fn options.withBasemapMixin - -```ts -withBasemapMixin(value) -``` - - - -#### fn options.withControls - -```ts -withControls(value) -``` - - - -#### fn options.withControlsMixin - -```ts -withControlsMixin(value) -``` - - - -#### fn options.withLayers - -```ts -withLayers(value) -``` - - - -#### fn options.withLayersMixin - -```ts -withLayersMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - - - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - - - -#### fn options.withView - -```ts -withView(value) -``` - - - -#### fn options.withViewMixin - -```ts -withViewMixin(value) -``` - - - -#### obj options.basemap - - -##### fn options.basemap.withConfig - -```ts -withConfig(value) -``` - -Custom options depending on the type - -##### fn options.basemap.withFilterData - -```ts -withFilterData(value) -``` - -Defines a frame MatcherConfig that may filter data for the given layer - -##### fn options.basemap.withLocation - -```ts -withLocation(value) -``` - - - -##### fn options.basemap.withLocationMixin - -```ts -withLocationMixin(value) -``` - - - -##### fn options.basemap.withName - -```ts -withName(value) -``` - -configured unique display name - -##### fn options.basemap.withOpacity - -```ts -withOpacity(value) -``` - -Common properties: -https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html -Layer opacity (0-1) - -##### fn options.basemap.withTooltip - -```ts -withTooltip(value) -``` - -Check tooltip (defaults to true) - -##### fn options.basemap.withType - -```ts -withType(value) -``` - - - -##### obj options.basemap.location - - -###### fn options.basemap.location.withGazetteer - -```ts -withGazetteer(value) -``` - -Path to Gazetteer - -###### fn options.basemap.location.withGeohash - -```ts -withGeohash(value) -``` - -Field mappings - -###### fn options.basemap.location.withLatitude - -```ts -withLatitude(value) -``` - - - -###### fn options.basemap.location.withLongitude - -```ts -withLongitude(value) -``` - - - -###### fn options.basemap.location.withLookup - -```ts -withLookup(value) -``` - - - -###### fn options.basemap.location.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "auto", "geohash", "coords", "lookup" - -###### fn options.basemap.location.withWkt - -```ts -withWkt(value) -``` - - - -#### obj options.controls - - -##### fn options.controls.withMouseWheelZoom - -```ts -withMouseWheelZoom(value) -``` - -let the mouse wheel zoom - -##### fn options.controls.withShowAttribution - -```ts -withShowAttribution(value) -``` - -Lower right - -##### fn options.controls.withShowDebug - -```ts -withShowDebug(value) -``` - -Show debug - -##### fn options.controls.withShowMeasure - -```ts -withShowMeasure(value) -``` - -Show measure - -##### fn options.controls.withShowScale - -```ts -withShowScale(value) -``` - -Scale options - -##### fn options.controls.withShowZoom - -```ts -withShowZoom(value) -``` - -Zoom (upper left) - -#### obj options.layers - - -##### fn options.layers.withConfig - -```ts -withConfig(value) -``` - -Custom options depending on the type - -##### fn options.layers.withFilterData - -```ts -withFilterData(value) -``` - -Defines a frame MatcherConfig that may filter data for the given layer - -##### fn options.layers.withLocation - -```ts -withLocation(value) -``` - - - -##### fn options.layers.withLocationMixin - -```ts -withLocationMixin(value) -``` - - - -##### fn options.layers.withName - -```ts -withName(value) -``` - -configured unique display name - -##### fn options.layers.withOpacity - -```ts -withOpacity(value) -``` - -Common properties: -https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html -Layer opacity (0-1) - -##### fn options.layers.withTooltip - -```ts -withTooltip(value) -``` - -Check tooltip (defaults to true) - -##### fn options.layers.withType - -```ts -withType(value) -``` - - - -##### obj options.layers.location - - -###### fn options.layers.location.withGazetteer - -```ts -withGazetteer(value) -``` - -Path to Gazetteer - -###### fn options.layers.location.withGeohash - -```ts -withGeohash(value) -``` - -Field mappings - -###### fn options.layers.location.withLatitude - -```ts -withLatitude(value) -``` - - - -###### fn options.layers.location.withLongitude - -```ts -withLongitude(value) -``` - - - -###### fn options.layers.location.withLookup - -```ts -withLookup(value) -``` - - - -###### fn options.layers.location.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "auto", "geohash", "coords", "lookup" - -###### fn options.layers.location.withWkt - -```ts -withWkt(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "none", "details" - -#### obj options.view - - -##### fn options.view.withAllLayers - -```ts -withAllLayers(value=true) -``` - - - -##### fn options.view.withId - -```ts -withId(value="zero") -``` - - - -##### fn options.view.withLastOnly - -```ts -withLastOnly(value) -``` - - - -##### fn options.view.withLat - -```ts -withLat(value=0) -``` - - - -##### fn options.view.withLayer - -```ts -withLayer(value) -``` - - - -##### fn options.view.withLon - -```ts -withLon(value=0) -``` - - - -##### fn options.view.withMaxZoom - -```ts -withMaxZoom(value) -``` - - - -##### fn options.view.withMinZoom - -```ts -withMinZoom(value) -``` - - - -##### fn options.view.withPadding - -```ts -withPadding(value) -``` - - - -##### fn options.view.withShared - -```ts -withShared(value) -``` - - - -##### fn options.view.withZoom - -```ts -withZoom(value=1) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/index.md deleted file mode 100644 index 316949e..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/index.md +++ /dev/null @@ -1,1420 +0,0 @@ -# heatmap - -grafonnet.panel.heatmap - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withCalculate(value=false)`](#fn-optionswithcalculate) - * [`fn withCalculation(value)`](#fn-optionswithcalculation) - * [`fn withCalculationMixin(value)`](#fn-optionswithcalculationmixin) - * [`fn withCellGap(value=1)`](#fn-optionswithcellgap) - * [`fn withCellRadius(value)`](#fn-optionswithcellradius) - * [`fn withCellValues(value={})`](#fn-optionswithcellvalues) - * [`fn withCellValuesMixin(value={})`](#fn-optionswithcellvaluesmixin) - * [`fn withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolor) - * [`fn withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolormixin) - * [`fn withExemplars(value)`](#fn-optionswithexemplars) - * [`fn withExemplarsMixin(value)`](#fn-optionswithexemplarsmixin) - * [`fn withFilterValues(value={"le": 0.000000001})`](#fn-optionswithfiltervalues) - * [`fn withFilterValuesMixin(value={"le": 0.000000001})`](#fn-optionswithfiltervaluesmixin) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withRowsFrame(value)`](#fn-optionswithrowsframe) - * [`fn withRowsFrameMixin(value)`](#fn-optionswithrowsframemixin) - * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`fn withYAxis(value)`](#fn-optionswithyaxis) - * [`fn withYAxisMixin(value)`](#fn-optionswithyaxismixin) - * [`obj calculation`](#obj-optionscalculation) - * [`fn withXBuckets(value)`](#fn-optionscalculationwithxbuckets) - * [`fn withXBucketsMixin(value)`](#fn-optionscalculationwithxbucketsmixin) - * [`fn withYBuckets(value)`](#fn-optionscalculationwithybuckets) - * [`fn withYBucketsMixin(value)`](#fn-optionscalculationwithybucketsmixin) - * [`obj xBuckets`](#obj-optionscalculationxbuckets) - * [`fn withMode(value)`](#fn-optionscalculationxbucketswithmode) - * [`fn withScale(value)`](#fn-optionscalculationxbucketswithscale) - * [`fn withScaleMixin(value)`](#fn-optionscalculationxbucketswithscalemixin) - * [`fn withValue(value)`](#fn-optionscalculationxbucketswithvalue) - * [`obj scale`](#obj-optionscalculationxbucketsscale) - * [`fn withLinearThreshold(value)`](#fn-optionscalculationxbucketsscalewithlinearthreshold) - * [`fn withLog(value)`](#fn-optionscalculationxbucketsscalewithlog) - * [`fn withType(value)`](#fn-optionscalculationxbucketsscalewithtype) - * [`obj yBuckets`](#obj-optionscalculationybuckets) - * [`fn withMode(value)`](#fn-optionscalculationybucketswithmode) - * [`fn withScale(value)`](#fn-optionscalculationybucketswithscale) - * [`fn withScaleMixin(value)`](#fn-optionscalculationybucketswithscalemixin) - * [`fn withValue(value)`](#fn-optionscalculationybucketswithvalue) - * [`obj scale`](#obj-optionscalculationybucketsscale) - * [`fn withLinearThreshold(value)`](#fn-optionscalculationybucketsscalewithlinearthreshold) - * [`fn withLog(value)`](#fn-optionscalculationybucketsscalewithlog) - * [`fn withType(value)`](#fn-optionscalculationybucketsscalewithtype) - * [`obj cellValues`](#obj-optionscellvalues) - * [`fn withCellValues(value)`](#fn-optionscellvalueswithcellvalues) - * [`fn withCellValuesMixin(value)`](#fn-optionscellvalueswithcellvaluesmixin) - * [`obj CellValues`](#obj-optionscellvaluescellvalues) - * [`fn withDecimals(value)`](#fn-optionscellvaluescellvalueswithdecimals) - * [`fn withUnit(value)`](#fn-optionscellvaluescellvalueswithunit) - * [`obj color`](#obj-optionscolor) - * [`fn withHeatmapColorOptions(value)`](#fn-optionscolorwithheatmapcoloroptions) - * [`fn withHeatmapColorOptionsMixin(value)`](#fn-optionscolorwithheatmapcoloroptionsmixin) - * [`obj HeatmapColorOptions`](#obj-optionscolorheatmapcoloroptions) - * [`fn withExponent(value)`](#fn-optionscolorheatmapcoloroptionswithexponent) - * [`fn withFill(value)`](#fn-optionscolorheatmapcoloroptionswithfill) - * [`fn withMax(value)`](#fn-optionscolorheatmapcoloroptionswithmax) - * [`fn withMin(value)`](#fn-optionscolorheatmapcoloroptionswithmin) - * [`fn withMode(value)`](#fn-optionscolorheatmapcoloroptionswithmode) - * [`fn withReverse(value)`](#fn-optionscolorheatmapcoloroptionswithreverse) - * [`fn withScale(value)`](#fn-optionscolorheatmapcoloroptionswithscale) - * [`fn withScheme(value)`](#fn-optionscolorheatmapcoloroptionswithscheme) - * [`fn withSteps(value)`](#fn-optionscolorheatmapcoloroptionswithsteps) - * [`obj exemplars`](#obj-optionsexemplars) - * [`fn withColor(value)`](#fn-optionsexemplarswithcolor) - * [`obj filterValues`](#obj-optionsfiltervalues) - * [`fn withFilterValueRange(value)`](#fn-optionsfiltervalueswithfiltervaluerange) - * [`fn withFilterValueRangeMixin(value)`](#fn-optionsfiltervalueswithfiltervaluerangemixin) - * [`obj FilterValueRange`](#obj-optionsfiltervaluesfiltervaluerange) - * [`fn withGe(value)`](#fn-optionsfiltervaluesfiltervaluerangewithge) - * [`fn withLe(value)`](#fn-optionsfiltervaluesfiltervaluerangewithle) - * [`obj legend`](#obj-optionslegend) - * [`fn withShow(value)`](#fn-optionslegendwithshow) - * [`obj rowsFrame`](#obj-optionsrowsframe) - * [`fn withLayout(value)`](#fn-optionsrowsframewithlayout) - * [`fn withValue(value)`](#fn-optionsrowsframewithvalue) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withShow(value)`](#fn-optionstooltipwithshow) - * [`fn withYHistogram(value)`](#fn-optionstooltipwithyhistogram) - * [`obj yAxis`](#obj-optionsyaxis) - * [`fn withAxisCenteredZero(value)`](#fn-optionsyaxiswithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-optionsyaxiswithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-optionsyaxiswithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-optionsyaxiswithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-optionsyaxiswithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-optionsyaxiswithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-optionsyaxiswithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-optionsyaxiswithaxiswidth) - * [`fn withDecimals(value)`](#fn-optionsyaxiswithdecimals) - * [`fn withMax(value)`](#fn-optionsyaxiswithmax) - * [`fn withMin(value)`](#fn-optionsyaxiswithmin) - * [`fn withReverse(value)`](#fn-optionsyaxiswithreverse) - * [`fn withScaleDistribution(value)`](#fn-optionsyaxiswithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-optionsyaxiswithscaledistributionmixin) - * [`fn withUnit(value)`](#fn-optionsyaxiswithunit) - * [`obj scaleDistribution`](#obj-optionsyaxisscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-optionsyaxisscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-optionsyaxisscaledistributionwithlog) - * [`fn withType(value)`](#fn-optionsyaxisscaledistributionwithtype) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new heatmap panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withCalculate - -```ts -withCalculate(value=false) -``` - -Controls if the heatmap should be calculated from data - -#### fn options.withCalculation - -```ts -withCalculation(value) -``` - - - -#### fn options.withCalculationMixin - -```ts -withCalculationMixin(value) -``` - - - -#### fn options.withCellGap - -```ts -withCellGap(value=1) -``` - -Controls gap between cells - -#### fn options.withCellRadius - -```ts -withCellRadius(value) -``` - -Controls cell radius - -#### fn options.withCellValues - -```ts -withCellValues(value={}) -``` - -Controls cell value unit - -#### fn options.withCellValuesMixin - -```ts -withCellValuesMixin(value={}) -``` - -Controls cell value unit - -#### fn options.withColor - -```ts -withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) -``` - -Controls the color options - -#### fn options.withColorMixin - -```ts -withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) -``` - -Controls the color options - -#### fn options.withExemplars - -```ts -withExemplars(value) -``` - -Controls exemplar options - -#### fn options.withExemplarsMixin - -```ts -withExemplarsMixin(value) -``` - -Controls exemplar options - -#### fn options.withFilterValues - -```ts -withFilterValues(value={"le": 0.000000001}) -``` - -Filters values between a given range - -#### fn options.withFilterValuesMixin - -```ts -withFilterValuesMixin(value={"le": 0.000000001}) -``` - -Filters values between a given range - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -Controls legend options - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -Controls legend options - -#### fn options.withRowsFrame - -```ts -withRowsFrame(value) -``` - -Controls frame rows options - -#### fn options.withRowsFrameMixin - -```ts -withRowsFrameMixin(value) -``` - -Controls frame rows options - -#### fn options.withShowValue - -```ts -withShowValue(value) -``` - -| *{ - layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed -} -Controls the display of the value in the cell - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -Controls tooltip options - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -Controls tooltip options - -#### fn options.withYAxis - -```ts -withYAxis(value) -``` - -Configuration options for the yAxis - -#### fn options.withYAxisMixin - -```ts -withYAxisMixin(value) -``` - -Configuration options for the yAxis - -#### obj options.calculation - - -##### fn options.calculation.withXBuckets - -```ts -withXBuckets(value) -``` - - - -##### fn options.calculation.withXBucketsMixin - -```ts -withXBucketsMixin(value) -``` - - - -##### fn options.calculation.withYBuckets - -```ts -withYBuckets(value) -``` - - - -##### fn options.calculation.withYBucketsMixin - -```ts -withYBucketsMixin(value) -``` - - - -##### obj options.calculation.xBuckets - - -###### fn options.calculation.xBuckets.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "size", "count" - -###### fn options.calculation.xBuckets.withScale - -```ts -withScale(value) -``` - -TODO docs - -###### fn options.calculation.xBuckets.withScaleMixin - -```ts -withScaleMixin(value) -``` - -TODO docs - -###### fn options.calculation.xBuckets.withValue - -```ts -withValue(value) -``` - -The number of buckets to use for the axis in the heatmap - -###### obj options.calculation.xBuckets.scale - - -####### fn options.calculation.xBuckets.scale.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn options.calculation.xBuckets.scale.withLog - -```ts -withLog(value) -``` - - - -####### fn options.calculation.xBuckets.scale.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -##### obj options.calculation.yBuckets - - -###### fn options.calculation.yBuckets.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "size", "count" - -###### fn options.calculation.yBuckets.withScale - -```ts -withScale(value) -``` - -TODO docs - -###### fn options.calculation.yBuckets.withScaleMixin - -```ts -withScaleMixin(value) -``` - -TODO docs - -###### fn options.calculation.yBuckets.withValue - -```ts -withValue(value) -``` - -The number of buckets to use for the axis in the heatmap - -###### obj options.calculation.yBuckets.scale - - -####### fn options.calculation.yBuckets.scale.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn options.calculation.yBuckets.scale.withLog - -```ts -withLog(value) -``` - - - -####### fn options.calculation.yBuckets.scale.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -#### obj options.cellValues - - -##### fn options.cellValues.withCellValues - -```ts -withCellValues(value) -``` - -Controls cell value options - -##### fn options.cellValues.withCellValuesMixin - -```ts -withCellValuesMixin(value) -``` - -Controls cell value options - -##### obj options.cellValues.CellValues - - -###### fn options.cellValues.CellValues.withDecimals - -```ts -withDecimals(value) -``` - -Controls the number of decimals for cell values - -###### fn options.cellValues.CellValues.withUnit - -```ts -withUnit(value) -``` - -Controls the cell value unit - -#### obj options.color - - -##### fn options.color.withHeatmapColorOptions - -```ts -withHeatmapColorOptions(value) -``` - -Controls various color options - -##### fn options.color.withHeatmapColorOptionsMixin - -```ts -withHeatmapColorOptionsMixin(value) -``` - -Controls various color options - -##### obj options.color.HeatmapColorOptions - - -###### fn options.color.HeatmapColorOptions.withExponent - -```ts -withExponent(value) -``` - -Controls the exponent when scale is set to exponential - -###### fn options.color.HeatmapColorOptions.withFill - -```ts -withFill(value) -``` - -Controls the color fill when in opacity mode - -###### fn options.color.HeatmapColorOptions.withMax - -```ts -withMax(value) -``` - -Sets the maximum value for the color scale - -###### fn options.color.HeatmapColorOptions.withMin - -```ts -withMin(value) -``` - -Sets the minimum value for the color scale - -###### fn options.color.HeatmapColorOptions.withMode - -```ts -withMode(value) -``` - -Controls the color mode of the heatmap - -Accepted values for `value` are "opacity", "scheme" - -###### fn options.color.HeatmapColorOptions.withReverse - -```ts -withReverse(value) -``` - -Reverses the color scheme - -###### fn options.color.HeatmapColorOptions.withScale - -```ts -withScale(value) -``` - -Controls the color scale of the heatmap - -Accepted values for `value` are "linear", "exponential" - -###### fn options.color.HeatmapColorOptions.withScheme - -```ts -withScheme(value) -``` - -Controls the color scheme used - -###### fn options.color.HeatmapColorOptions.withSteps - -```ts -withSteps(value) -``` - -Controls the number of color steps - -#### obj options.exemplars - - -##### fn options.exemplars.withColor - -```ts -withColor(value) -``` - -Sets the color of the exemplar markers - -#### obj options.filterValues - - -##### fn options.filterValues.withFilterValueRange - -```ts -withFilterValueRange(value) -``` - -Controls the value filter range - -##### fn options.filterValues.withFilterValueRangeMixin - -```ts -withFilterValueRangeMixin(value) -``` - -Controls the value filter range - -##### obj options.filterValues.FilterValueRange - - -###### fn options.filterValues.FilterValueRange.withGe - -```ts -withGe(value) -``` - -Sets the filter range to values greater than or equal to the given value - -###### fn options.filterValues.FilterValueRange.withLe - -```ts -withLe(value) -``` - -Sets the filter range to values less than or equal to the given value - -#### obj options.legend - - -##### fn options.legend.withShow - -```ts -withShow(value) -``` - -Controls if the legend is shown - -#### obj options.rowsFrame - - -##### fn options.rowsFrame.withLayout - -```ts -withLayout(value) -``` - - - -Accepted values for `value` are "le", "ge", "unknown", "auto" - -##### fn options.rowsFrame.withValue - -```ts -withValue(value) -``` - -Sets the name of the cell when not calculating from data - -#### obj options.tooltip - - -##### fn options.tooltip.withShow - -```ts -withShow(value) -``` - -Controls if the tooltip is shown - -##### fn options.tooltip.withYHistogram - -```ts -withYHistogram(value) -``` - -Controls if the tooltip shows a histogram of the y-axis values - -#### obj options.yAxis - - -##### fn options.yAxis.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -##### fn options.yAxis.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -##### fn options.yAxis.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -##### fn options.yAxis.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -##### fn options.yAxis.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -##### fn options.yAxis.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -##### fn options.yAxis.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -##### fn options.yAxis.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -##### fn options.yAxis.withDecimals - -```ts -withDecimals(value) -``` - -Controls the number of decimals for yAxis values - -##### fn options.yAxis.withMax - -```ts -withMax(value) -``` - -Sets the maximum value for the yAxis - -##### fn options.yAxis.withMin - -```ts -withMin(value) -``` - -Sets the minimum value for the yAxis - -##### fn options.yAxis.withReverse - -```ts -withReverse(value) -``` - -Reverses the yAxis - -##### fn options.yAxis.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -##### fn options.yAxis.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -##### fn options.yAxis.withUnit - -```ts -withUnit(value) -``` - -Sets the yAxis unit - -##### obj options.yAxis.scaleDistribution - - -###### fn options.yAxis.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -###### fn options.yAxis.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -###### fn options.yAxis.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/index.md deleted file mode 100644 index fc3218d..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/index.md +++ /dev/null @@ -1,874 +0,0 @@ -# histogram - -grafonnet.panel.histogram - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withAxisCenteredZero(value)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) - * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withBucketOffset(value=0)`](#fn-optionswithbucketoffset) - * [`fn withBucketSize(value)`](#fn-optionswithbucketsize) - * [`fn withCombine(value)`](#fn-optionswithcombine) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new histogram panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -###### fn fieldConfig.defaults.custom.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -###### fn fieldConfig.defaults.custom.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value=80) -``` - -Controls the fill opacity of the bars. - -###### fn fieldConfig.defaults.custom.withGradientMode - -```ts -withGradientMode(value) -``` - -Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. -Gradient appearance is influenced by the Fill opacity setting. - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value=1) -``` - -Controls line width of the bars. - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withBucketOffset - -```ts -withBucketOffset(value=0) -``` - -Offset buckets by this amount - -#### fn options.withBucketSize - -```ts -withBucketSize(value) -``` - -Size of each bucket - -#### fn options.withCombine - -```ts -withCombine(value) -``` - -Combines multiple series into a single histogram - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/index.md deleted file mode 100644 index eb4916a..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/index.md +++ /dev/null @@ -1,546 +0,0 @@ -# logs - -grafonnet.panel.logs - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withDedupStrategy(value)`](#fn-optionswithdedupstrategy) - * [`fn withEnableLogDetails(value)`](#fn-optionswithenablelogdetails) - * [`fn withPrettifyLogMessage(value)`](#fn-optionswithprettifylogmessage) - * [`fn withShowCommonLabels(value)`](#fn-optionswithshowcommonlabels) - * [`fn withShowLabels(value)`](#fn-optionswithshowlabels) - * [`fn withShowTime(value)`](#fn-optionswithshowtime) - * [`fn withSortOrder(value)`](#fn-optionswithsortorder) - * [`fn withWrapLogMessage(value)`](#fn-optionswithwraplogmessage) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new logs panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withDedupStrategy - -```ts -withDedupStrategy(value) -``` - - - -Accepted values for `value` are "none", "exact", "numbers", "signature" - -#### fn options.withEnableLogDetails - -```ts -withEnableLogDetails(value) -``` - - - -#### fn options.withPrettifyLogMessage - -```ts -withPrettifyLogMessage(value) -``` - - - -#### fn options.withShowCommonLabels - -```ts -withShowCommonLabels(value) -``` - - - -#### fn options.withShowLabels - -```ts -withShowLabels(value) -``` - - - -#### fn options.withShowTime - -```ts -withShowTime(value) -``` - - - -#### fn options.withSortOrder - -```ts -withSortOrder(value) -``` - - - -Accepted values for `value` are "Descending", "Ascending" - -#### fn options.withWrapLogMessage - -```ts -withWrapLogMessage(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/index.md deleted file mode 100644 index daa046c..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/index.md +++ /dev/null @@ -1,488 +0,0 @@ -# news - -grafonnet.panel.news - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withFeedUrl(value)`](#fn-optionswithfeedurl) - * [`fn withShowImage(value=true)`](#fn-optionswithshowimage) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new news panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withFeedUrl - -```ts -withFeedUrl(value) -``` - -empty/missing will default to grafana blog - -#### fn options.withShowImage - -```ts -withShowImage(value=true) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/index.md deleted file mode 100644 index 4bc338f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/index.md +++ /dev/null @@ -1,590 +0,0 @@ -# nodeGraph - -grafonnet.panel.nodeGraph - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withEdges(value)`](#fn-optionswithedges) - * [`fn withEdgesMixin(value)`](#fn-optionswithedgesmixin) - * [`fn withNodes(value)`](#fn-optionswithnodes) - * [`fn withNodesMixin(value)`](#fn-optionswithnodesmixin) - * [`obj edges`](#obj-optionsedges) - * [`fn withMainStatUnit(value)`](#fn-optionsedgeswithmainstatunit) - * [`fn withSecondaryStatUnit(value)`](#fn-optionsedgeswithsecondarystatunit) - * [`obj nodes`](#obj-optionsnodes) - * [`fn withArcs(value)`](#fn-optionsnodeswitharcs) - * [`fn withArcsMixin(value)`](#fn-optionsnodeswitharcsmixin) - * [`fn withMainStatUnit(value)`](#fn-optionsnodeswithmainstatunit) - * [`fn withSecondaryStatUnit(value)`](#fn-optionsnodeswithsecondarystatunit) - * [`obj arcs`](#obj-optionsnodesarcs) - * [`fn withColor(value)`](#fn-optionsnodesarcswithcolor) - * [`fn withField(value)`](#fn-optionsnodesarcswithfield) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new nodeGraph panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withEdges - -```ts -withEdges(value) -``` - - - -#### fn options.withEdgesMixin - -```ts -withEdgesMixin(value) -``` - - - -#### fn options.withNodes - -```ts -withNodes(value) -``` - - - -#### fn options.withNodesMixin - -```ts -withNodesMixin(value) -``` - - - -#### obj options.edges - - -##### fn options.edges.withMainStatUnit - -```ts -withMainStatUnit(value) -``` - -Unit for the main stat to override what ever is set in the data frame. - -##### fn options.edges.withSecondaryStatUnit - -```ts -withSecondaryStatUnit(value) -``` - -Unit for the secondary stat to override what ever is set in the data frame. - -#### obj options.nodes - - -##### fn options.nodes.withArcs - -```ts -withArcs(value) -``` - -Define which fields are shown as part of the node arc (colored circle around the node). - -##### fn options.nodes.withArcsMixin - -```ts -withArcsMixin(value) -``` - -Define which fields are shown as part of the node arc (colored circle around the node). - -##### fn options.nodes.withMainStatUnit - -```ts -withMainStatUnit(value) -``` - -Unit for the main stat to override what ever is set in the data frame. - -##### fn options.nodes.withSecondaryStatUnit - -```ts -withSecondaryStatUnit(value) -``` - -Unit for the secondary stat to override what ever is set in the data frame. - -##### obj options.nodes.arcs - - -###### fn options.nodes.arcs.withColor - -```ts -withColor(value) -``` - -The color of the arc. - -###### fn options.nodes.arcs.withField - -```ts -withField(value) -``` - -Field from which to get the value. Values should be less than 1, representing fraction of a circle. - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/index.md deleted file mode 100644 index c919257..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/index.md +++ /dev/null @@ -1,857 +0,0 @@ -# pieChart - -grafonnet.panel.pieChart - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withDisplayLabels(value)`](#fn-optionswithdisplaylabels) - * [`fn withDisplayLabelsMixin(value)`](#fn-optionswithdisplaylabelsmixin) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withPieType(value)`](#fn-optionswithpietype) - * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) - * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withValues(value)`](#fn-optionslegendwithvalues) - * [`fn withValuesMixin(value)`](#fn-optionslegendwithvaluesmixin) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj reduceOptions`](#obj-optionsreduceoptions) - * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) - * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) - * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) - * [`fn withValues(value)`](#fn-optionsreduceoptionswithvalues) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new pieChart panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withDisplayLabels - -```ts -withDisplayLabels(value) -``` - - - -#### fn options.withDisplayLabelsMixin - -```ts -withDisplayLabelsMixin(value) -``` - - - -#### fn options.withLegend - -```ts -withLegend(value) -``` - - - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - - - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "vertical", "horizontal" - -#### fn options.withPieType - -```ts -withPieType(value) -``` - -Select the pie chart display style. - -Accepted values for `value` are "pie", "donut" - -#### fn options.withReduceOptions - -```ts -withReduceOptions(value) -``` - -TODO docs - -#### fn options.withReduceOptionsMixin - -```ts -withReduceOptionsMixin(value) -``` - -TODO docs - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withValues - -```ts -withValues(value) -``` - - - -##### fn options.legend.withValuesMixin - -```ts -withValuesMixin(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.reduceOptions - - -##### fn options.reduceOptions.withCalcs - -```ts -withCalcs(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withFields - -```ts -withFields(value) -``` - -Which fields to show. By default this is only numeric fields - -##### fn options.reduceOptions.withLimit - -```ts -withLimit(value) -``` - -if showing all values limit - -##### fn options.reduceOptions.withValues - -```ts -withValues(value) -``` - -If true show each row value - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/index.md deleted file mode 100644 index 259e64c..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/index.md +++ /dev/null @@ -1,632 +0,0 @@ -# stat - -grafonnet.panel.stat - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withColorMode(value)`](#fn-optionswithcolormode) - * [`fn withGraphMode(value)`](#fn-optionswithgraphmode) - * [`fn withJustifyMode(value)`](#fn-optionswithjustifymode) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) - * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`fn withTextMode(value)`](#fn-optionswithtextmode) - * [`obj reduceOptions`](#obj-optionsreduceoptions) - * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) - * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) - * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) - * [`fn withValues(value)`](#fn-optionsreduceoptionswithvalues) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new stat panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withColorMode - -```ts -withColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "value", "background", "background_solid", "none" - -#### fn options.withGraphMode - -```ts -withGraphMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "line", "area" - -#### fn options.withJustifyMode - -```ts -withJustifyMode(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "center" - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "vertical", "horizontal" - -#### fn options.withReduceOptions - -```ts -withReduceOptions(value) -``` - -TODO docs - -#### fn options.withReduceOptionsMixin - -```ts -withReduceOptionsMixin(value) -``` - -TODO docs - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### fn options.withTextMode - -```ts -withTextMode(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "value", "value_and_name", "name", "none" - -#### obj options.reduceOptions - - -##### fn options.reduceOptions.withCalcs - -```ts -withCalcs(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withFields - -```ts -withFields(value) -``` - -Which fields to show. By default this is only numeric fields - -##### fn options.reduceOptions.withLimit - -```ts -withLimit(value) -``` - -if showing all values limit - -##### fn options.reduceOptions.withValues - -```ts -withValues(value) -``` - -If true show each row value - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/index.md deleted file mode 100644 index 78b99cd..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/index.md +++ /dev/null @@ -1,764 +0,0 @@ -# stateTimeline - -grafonnet.panel.stateTimeline - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineWidth(value=0)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withAlignValue(value)`](#fn-optionswithalignvalue) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withMergeValues(value=true)`](#fn-optionswithmergevalues) - * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) - * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withTimezone(value)`](#fn-optionswithtimezone) - * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new stateTimeline panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value=70) -``` - - - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value=0) -``` - - - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withAlignValue - -```ts -withAlignValue(value) -``` - -Controls value alignment on the timelines - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withMergeValues - -```ts -withMergeValues(value=true) -``` - -Merge equal consecutive values - -#### fn options.withRowHeight - -```ts -withRowHeight(value=0.9) -``` - -Controls the row height - -#### fn options.withShowValue - -```ts -withShowValue(value) -``` - -Show timeline values on chart - -#### fn options.withTimezone - -```ts -withTimezone(value) -``` - - - -#### fn options.withTimezoneMixin - -```ts -withTimezoneMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/index.md deleted file mode 100644 index 6de8abc..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/index.md +++ /dev/null @@ -1,755 +0,0 @@ -# statusHistory - -grafonnet.panel.statusHistory - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withColWidth(value=0.9)`](#fn-optionswithcolwidth) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) - * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withTimezone(value)`](#fn-optionswithtimezone) - * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new statusHistory panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value=70) -``` - - - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value=1) -``` - - - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withColWidth - -```ts -withColWidth(value=0.9) -``` - -Controls the column width - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withRowHeight - -```ts -withRowHeight(value=0.9) -``` - -Set the height of the rows - -#### fn options.withShowValue - -```ts -withShowValue(value) -``` - -Show values on the columns - -#### fn options.withTimezone - -```ts -withTimezone(value) -``` - - - -#### fn options.withTimezoneMixin - -```ts -withTimezoneMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/index.md deleted file mode 100644 index fc39e41..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/index.md +++ /dev/null @@ -1,653 +0,0 @@ -# table - -grafonnet.panel.table - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withCellHeight(value)`](#fn-optionswithcellheight) - * [`fn withFooter(value={"countRows": false,"reducer": [],"show": false})`](#fn-optionswithfooter) - * [`fn withFooterMixin(value={"countRows": false,"reducer": [],"show": false})`](#fn-optionswithfootermixin) - * [`fn withFrameIndex(value=0)`](#fn-optionswithframeindex) - * [`fn withShowHeader(value=true)`](#fn-optionswithshowheader) - * [`fn withShowTypeIcons(value=false)`](#fn-optionswithshowtypeicons) - * [`fn withSortBy(value)`](#fn-optionswithsortby) - * [`fn withSortByMixin(value)`](#fn-optionswithsortbymixin) - * [`obj footer`](#obj-optionsfooter) - * [`fn withTableFooterOptions(value)`](#fn-optionsfooterwithtablefooteroptions) - * [`fn withTableFooterOptionsMixin(value)`](#fn-optionsfooterwithtablefooteroptionsmixin) - * [`obj TableFooterOptions`](#obj-optionsfootertablefooteroptions) - * [`fn withCountRows(value)`](#fn-optionsfootertablefooteroptionswithcountrows) - * [`fn withEnablePagination(value)`](#fn-optionsfootertablefooteroptionswithenablepagination) - * [`fn withFields(value)`](#fn-optionsfootertablefooteroptionswithfields) - * [`fn withFieldsMixin(value)`](#fn-optionsfootertablefooteroptionswithfieldsmixin) - * [`fn withReducer(value)`](#fn-optionsfootertablefooteroptionswithreducer) - * [`fn withReducerMixin(value)`](#fn-optionsfootertablefooteroptionswithreducermixin) - * [`fn withShow(value)`](#fn-optionsfootertablefooteroptionswithshow) - * [`obj sortBy`](#obj-optionssortby) - * [`fn withDesc(value)`](#fn-optionssortbywithdesc) - * [`fn withDisplayName(value)`](#fn-optionssortbywithdisplayname) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new table panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withCellHeight - -```ts -withCellHeight(value) -``` - -Controls the height of the rows - -#### fn options.withFooter - -```ts -withFooter(value={"countRows": false,"reducer": [],"show": false}) -``` - -Controls footer options - -#### fn options.withFooterMixin - -```ts -withFooterMixin(value={"countRows": false,"reducer": [],"show": false}) -``` - -Controls footer options - -#### fn options.withFrameIndex - -```ts -withFrameIndex(value=0) -``` - -Represents the index of the selected frame - -#### fn options.withShowHeader - -```ts -withShowHeader(value=true) -``` - -Controls whether the panel should show the header - -#### fn options.withShowTypeIcons - -```ts -withShowTypeIcons(value=false) -``` - -Controls whether the header should show icons for the column types - -#### fn options.withSortBy - -```ts -withSortBy(value) -``` - -Used to control row sorting - -#### fn options.withSortByMixin - -```ts -withSortByMixin(value) -``` - -Used to control row sorting - -#### obj options.footer - - -##### fn options.footer.withTableFooterOptions - -```ts -withTableFooterOptions(value) -``` - -Footer options - -##### fn options.footer.withTableFooterOptionsMixin - -```ts -withTableFooterOptionsMixin(value) -``` - -Footer options - -##### obj options.footer.TableFooterOptions - - -###### fn options.footer.TableFooterOptions.withCountRows - -```ts -withCountRows(value) -``` - - - -###### fn options.footer.TableFooterOptions.withEnablePagination - -```ts -withEnablePagination(value) -``` - - - -###### fn options.footer.TableFooterOptions.withFields - -```ts -withFields(value) -``` - - - -###### fn options.footer.TableFooterOptions.withFieldsMixin - -```ts -withFieldsMixin(value) -``` - - - -###### fn options.footer.TableFooterOptions.withReducer - -```ts -withReducer(value) -``` - - - -###### fn options.footer.TableFooterOptions.withReducerMixin - -```ts -withReducerMixin(value) -``` - - - -###### fn options.footer.TableFooterOptions.withShow - -```ts -withShow(value) -``` - - - -#### obj options.sortBy - - -##### fn options.sortBy.withDesc - -```ts -withDesc(value) -``` - -Flag used to indicate descending sort order - -##### fn options.sortBy.withDisplayName - -```ts -withDisplayName(value) -``` - -Sets the display name of the field to sort by - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/index.md deleted file mode 100644 index 8660df9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/index.md +++ /dev/null @@ -1,541 +0,0 @@ -# text - -grafonnet.panel.text - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withCode(value)`](#fn-optionswithcode) - * [`fn withCodeMixin(value)`](#fn-optionswithcodemixin) - * [`fn withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)")`](#fn-optionswithcontent) - * [`fn withMode(value)`](#fn-optionswithmode) - * [`obj code`](#obj-optionscode) - * [`fn withLanguage(value="plaintext")`](#fn-optionscodewithlanguage) - * [`fn withShowLineNumbers(value=false)`](#fn-optionscodewithshowlinenumbers) - * [`fn withShowMiniMap(value=false)`](#fn-optionscodewithshowminimap) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new text panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withCode - -```ts -withCode(value) -``` - - - -#### fn options.withCodeMixin - -```ts -withCodeMixin(value) -``` - - - -#### fn options.withContent - -```ts -withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)") -``` - - - -#### fn options.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "html", "markdown", "code" - -#### obj options.code - - -##### fn options.code.withLanguage - -```ts -withLanguage(value="plaintext") -``` - - - -Accepted values for `value` are "plaintext", "yaml", "xml", "typescript", "sql", "go", "markdown", "html", "json" - -##### fn options.code.withShowLineNumbers - -```ts -withShowLineNumbers(value=false) -``` - - - -##### fn options.code.withShowMiniMap - -```ts -withShowMiniMap(value=false) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/index.md deleted file mode 100644 index c2cb3fa..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/index.md +++ /dev/null @@ -1,1141 +0,0 @@ -# timeSeries - -grafonnet.panel.timeSeries - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withAxisCenteredZero(value)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) - * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) - * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) - * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) - * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) - * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) - * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) - * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) - * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) - * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) - * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) - * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) - * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) - * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) - * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) - * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) - * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) - * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) - * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) - * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) - * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) - * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) - * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) - * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) - * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) - * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) - * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withTimezone(value)`](#fn-optionswithtimezone) - * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new timeSeries panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -###### fn fieldConfig.defaults.custom.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -###### fn fieldConfig.defaults.custom.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withBarAlignment - -```ts -withBarAlignment(value) -``` - -TODO docs - -Accepted values for `value` are -1, 0, 1 - -###### fn fieldConfig.defaults.custom.withBarMaxWidth - -```ts -withBarMaxWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withBarWidthFactor - -```ts -withBarWidthFactor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withDrawStyle - -```ts -withDrawStyle(value) -``` - -TODO docs - -Accepted values for `value` are "line", "bars", "points" - -###### fn fieldConfig.defaults.custom.withFillBelowTo - -```ts -withFillBelowTo(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillColor - -```ts -withFillColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value) -``` - - - -###### fn fieldConfig.defaults.custom.withGradientMode - -```ts -withGradientMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "opacity", "hue", "scheme" - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineColor - -```ts -withLineColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withLineInterpolation - -```ts -withLineInterpolation(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "smooth", "stepBefore", "stepAfter" - -###### fn fieldConfig.defaults.custom.withLineStyle - -```ts -withLineStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineStyleMixin - -```ts -withLineStyleMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointColor - -```ts -withPointColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointSize - -```ts -withPointSize(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointSymbol - -```ts -withPointSymbol(value) -``` - - - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withShowPoints - -```ts -withShowPoints(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "never", "always" - -###### fn fieldConfig.defaults.custom.withSpanNulls - -```ts -withSpanNulls(value) -``` - -Indicate if null values should be treated as gaps or connected. -When the value is a number, it represents the maximum delta in the -X axis that should be considered connected. For timeseries, this is milliseconds - -###### fn fieldConfig.defaults.custom.withSpanNullsMixin - -```ts -withSpanNullsMixin(value) -``` - -Indicate if null values should be treated as gaps or connected. -When the value is a number, it represents the maximum delta in the -X axis that should be considered connected. For timeseries, this is milliseconds - -###### fn fieldConfig.defaults.custom.withStacking - -```ts -withStacking(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withStackingMixin - -```ts -withStackingMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyle - -```ts -withThresholdsStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin - -```ts -withThresholdsStyleMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withTransform - -```ts -withTransform(value) -``` - -TODO docs - -Accepted values for `value` are "constant", "negative-Y" - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.lineStyle - - -####### fn fieldConfig.defaults.custom.lineStyle.withDash - -```ts -withDash(value) -``` - - - -####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin - -```ts -withDashMixin(value) -``` - - - -####### fn fieldConfig.defaults.custom.lineStyle.withFill - -```ts -withFill(value) -``` - - - -Accepted values for `value` are "solid", "dash", "dot", "square" - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -###### obj fieldConfig.defaults.custom.stacking - - -####### fn fieldConfig.defaults.custom.stacking.withGroup - -```ts -withGroup(value) -``` - - - -####### fn fieldConfig.defaults.custom.stacking.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "normal", "percent" - -###### obj fieldConfig.defaults.custom.thresholdsStyle - - -####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "off", "line", "dashed", "area", "line+area", "dashed+area", "series" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withTimezone - -```ts -withTimezone(value) -``` - - - -#### fn options.withTimezoneMixin - -```ts -withTimezoneMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/index.md deleted file mode 100644 index b9feb7b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/index.md +++ /dev/null @@ -1,1132 +0,0 @@ -# trend - -grafonnet.panel.trend - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withAxisCenteredZero(value)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) - * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) - * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) - * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) - * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) - * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) - * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) - * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) - * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) - * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) - * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) - * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) - * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) - * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) - * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) - * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) - * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) - * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) - * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) - * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) - * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) - * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) - * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) - * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) - * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) - * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) - * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`fn withXField(value)`](#fn-optionswithxfield) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new trend panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -###### fn fieldConfig.defaults.custom.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -###### fn fieldConfig.defaults.custom.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withBarAlignment - -```ts -withBarAlignment(value) -``` - -TODO docs - -Accepted values for `value` are -1, 0, 1 - -###### fn fieldConfig.defaults.custom.withBarMaxWidth - -```ts -withBarMaxWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withBarWidthFactor - -```ts -withBarWidthFactor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withDrawStyle - -```ts -withDrawStyle(value) -``` - -TODO docs - -Accepted values for `value` are "line", "bars", "points" - -###### fn fieldConfig.defaults.custom.withFillBelowTo - -```ts -withFillBelowTo(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillColor - -```ts -withFillColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value) -``` - - - -###### fn fieldConfig.defaults.custom.withGradientMode - -```ts -withGradientMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "opacity", "hue", "scheme" - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineColor - -```ts -withLineColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withLineInterpolation - -```ts -withLineInterpolation(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "smooth", "stepBefore", "stepAfter" - -###### fn fieldConfig.defaults.custom.withLineStyle - -```ts -withLineStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineStyleMixin - -```ts -withLineStyleMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointColor - -```ts -withPointColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointSize - -```ts -withPointSize(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointSymbol - -```ts -withPointSymbol(value) -``` - - - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withShowPoints - -```ts -withShowPoints(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "never", "always" - -###### fn fieldConfig.defaults.custom.withSpanNulls - -```ts -withSpanNulls(value) -``` - -Indicate if null values should be treated as gaps or connected. -When the value is a number, it represents the maximum delta in the -X axis that should be considered connected. For timeseries, this is milliseconds - -###### fn fieldConfig.defaults.custom.withSpanNullsMixin - -```ts -withSpanNullsMixin(value) -``` - -Indicate if null values should be treated as gaps or connected. -When the value is a number, it represents the maximum delta in the -X axis that should be considered connected. For timeseries, this is milliseconds - -###### fn fieldConfig.defaults.custom.withStacking - -```ts -withStacking(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withStackingMixin - -```ts -withStackingMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyle - -```ts -withThresholdsStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin - -```ts -withThresholdsStyleMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withTransform - -```ts -withTransform(value) -``` - -TODO docs - -Accepted values for `value` are "constant", "negative-Y" - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.lineStyle - - -####### fn fieldConfig.defaults.custom.lineStyle.withDash - -```ts -withDash(value) -``` - - - -####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin - -```ts -withDashMixin(value) -``` - - - -####### fn fieldConfig.defaults.custom.lineStyle.withFill - -```ts -withFill(value) -``` - - - -Accepted values for `value` are "solid", "dash", "dot", "square" - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -###### obj fieldConfig.defaults.custom.stacking - - -####### fn fieldConfig.defaults.custom.stacking.withGroup - -```ts -withGroup(value) -``` - - - -####### fn fieldConfig.defaults.custom.stacking.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "normal", "percent" - -###### obj fieldConfig.defaults.custom.thresholdsStyle - - -####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "off", "line", "dashed", "area", "line+area", "dashed+area", "series" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### fn options.withXField - -```ts -withXField(value) -``` - -Name of the x field to use (defaults to first number) - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/index.md deleted file mode 100644 index d58e181..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/index.md +++ /dev/null @@ -1,1207 +0,0 @@ -# xyChart - -grafonnet.panel.xyChart - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withDims(value)`](#fn-optionswithdims) - * [`fn withDimsMixin(value)`](#fn-optionswithdimsmixin) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withSeries(value)`](#fn-optionswithseries) - * [`fn withSeriesMapping(value)`](#fn-optionswithseriesmapping) - * [`fn withSeriesMixin(value)`](#fn-optionswithseriesmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj dims`](#obj-optionsdims) - * [`fn withExclude(value)`](#fn-optionsdimswithexclude) - * [`fn withExcludeMixin(value)`](#fn-optionsdimswithexcludemixin) - * [`fn withFrame(value)`](#fn-optionsdimswithframe) - * [`fn withX(value)`](#fn-optionsdimswithx) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj series`](#obj-optionsseries) - * [`fn withAxisCenteredZero(value)`](#fn-optionsserieswithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-optionsserieswithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-optionsserieswithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-optionsserieswithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-optionsserieswithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-optionsserieswithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-optionsserieswithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-optionsserieswithaxiswidth) - * [`fn withHideFrom(value)`](#fn-optionsserieswithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-optionsserieswithhidefrommixin) - * [`fn withLabel(value)`](#fn-optionsserieswithlabel) - * [`fn withLabelValue(value)`](#fn-optionsserieswithlabelvalue) - * [`fn withLabelValueMixin(value)`](#fn-optionsserieswithlabelvaluemixin) - * [`fn withLineColor(value)`](#fn-optionsserieswithlinecolor) - * [`fn withLineColorMixin(value)`](#fn-optionsserieswithlinecolormixin) - * [`fn withLineStyle(value)`](#fn-optionsserieswithlinestyle) - * [`fn withLineStyleMixin(value)`](#fn-optionsserieswithlinestylemixin) - * [`fn withLineWidth(value)`](#fn-optionsserieswithlinewidth) - * [`fn withName(value)`](#fn-optionsserieswithname) - * [`fn withPointColor(value)`](#fn-optionsserieswithpointcolor) - * [`fn withPointColorMixin(value)`](#fn-optionsserieswithpointcolormixin) - * [`fn withPointSize(value)`](#fn-optionsserieswithpointsize) - * [`fn withPointSizeMixin(value)`](#fn-optionsserieswithpointsizemixin) - * [`fn withScaleDistribution(value)`](#fn-optionsserieswithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-optionsserieswithscaledistributionmixin) - * [`fn withShow(value)`](#fn-optionsserieswithshow) - * [`fn withX(value)`](#fn-optionsserieswithx) - * [`fn withY(value)`](#fn-optionsserieswithy) - * [`obj hideFrom`](#obj-optionsserieshidefrom) - * [`fn withLegend(value)`](#fn-optionsserieshidefromwithlegend) - * [`fn withTooltip(value)`](#fn-optionsserieshidefromwithtooltip) - * [`fn withViz(value)`](#fn-optionsserieshidefromwithviz) - * [`obj labelValue`](#obj-optionsserieslabelvalue) - * [`fn withField(value)`](#fn-optionsserieslabelvaluewithfield) - * [`fn withFixed(value)`](#fn-optionsserieslabelvaluewithfixed) - * [`fn withMode(value)`](#fn-optionsserieslabelvaluewithmode) - * [`obj lineColor`](#obj-optionsserieslinecolor) - * [`fn withField(value)`](#fn-optionsserieslinecolorwithfield) - * [`fn withFixed(value)`](#fn-optionsserieslinecolorwithfixed) - * [`obj lineStyle`](#obj-optionsserieslinestyle) - * [`fn withDash(value)`](#fn-optionsserieslinestylewithdash) - * [`fn withDashMixin(value)`](#fn-optionsserieslinestylewithdashmixin) - * [`fn withFill(value)`](#fn-optionsserieslinestylewithfill) - * [`obj pointColor`](#obj-optionsseriespointcolor) - * [`fn withField(value)`](#fn-optionsseriespointcolorwithfield) - * [`fn withFixed(value)`](#fn-optionsseriespointcolorwithfixed) - * [`obj pointSize`](#obj-optionsseriespointsize) - * [`fn withField(value)`](#fn-optionsseriespointsizewithfield) - * [`fn withFixed(value)`](#fn-optionsseriespointsizewithfixed) - * [`fn withMax(value)`](#fn-optionsseriespointsizewithmax) - * [`fn withMin(value)`](#fn-optionsseriespointsizewithmin) - * [`fn withMode(value)`](#fn-optionsseriespointsizewithmode) - * [`obj scaleDistribution`](#obj-optionsseriesscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-optionsseriesscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-optionsseriesscaledistributionwithlog) - * [`fn withType(value)`](#fn-optionsseriesscaledistributionwithtype) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new xyChart panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withDims - -```ts -withDims(value) -``` - - - -#### fn options.withDimsMixin - -```ts -withDimsMixin(value) -``` - - - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withSeries - -```ts -withSeries(value) -``` - - - -#### fn options.withSeriesMapping - -```ts -withSeriesMapping(value) -``` - - - -Accepted values for `value` are "auto", "manual" - -#### fn options.withSeriesMixin - -```ts -withSeriesMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.dims - - -##### fn options.dims.withExclude - -```ts -withExclude(value) -``` - - - -##### fn options.dims.withExcludeMixin - -```ts -withExcludeMixin(value) -``` - - - -##### fn options.dims.withFrame - -```ts -withFrame(value) -``` - - - -##### fn options.dims.withX - -```ts -withX(value) -``` - - - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.series - - -##### fn options.series.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -##### fn options.series.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -##### fn options.series.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -##### fn options.series.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -##### fn options.series.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -##### fn options.series.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -##### fn options.series.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -##### fn options.series.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -##### fn options.series.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -##### fn options.series.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -##### fn options.series.withLabel - -```ts -withLabel(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "never", "always" - -##### fn options.series.withLabelValue - -```ts -withLabelValue(value) -``` - - - -##### fn options.series.withLabelValueMixin - -```ts -withLabelValueMixin(value) -``` - - - -##### fn options.series.withLineColor - -```ts -withLineColor(value) -``` - - - -##### fn options.series.withLineColorMixin - -```ts -withLineColorMixin(value) -``` - - - -##### fn options.series.withLineStyle - -```ts -withLineStyle(value) -``` - -TODO docs - -##### fn options.series.withLineStyleMixin - -```ts -withLineStyleMixin(value) -``` - -TODO docs - -##### fn options.series.withLineWidth - -```ts -withLineWidth(value) -``` - - - -##### fn options.series.withName - -```ts -withName(value) -``` - - - -##### fn options.series.withPointColor - -```ts -withPointColor(value) -``` - - - -##### fn options.series.withPointColorMixin - -```ts -withPointColorMixin(value) -``` - - - -##### fn options.series.withPointSize - -```ts -withPointSize(value) -``` - - - -##### fn options.series.withPointSizeMixin - -```ts -withPointSizeMixin(value) -``` - - - -##### fn options.series.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -##### fn options.series.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -##### fn options.series.withShow - -```ts -withShow(value) -``` - - - -Accepted values for `value` are "points", "lines", "points+lines" - -##### fn options.series.withX - -```ts -withX(value) -``` - - - -##### fn options.series.withY - -```ts -withY(value) -``` - - - -##### obj options.series.hideFrom - - -###### fn options.series.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -###### fn options.series.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -###### fn options.series.hideFrom.withViz - -```ts -withViz(value) -``` - - - -##### obj options.series.labelValue - - -###### fn options.series.labelValue.withField - -```ts -withField(value) -``` - -fixed: T -- will be added by each element - -###### fn options.series.labelValue.withFixed - -```ts -withFixed(value) -``` - - - -###### fn options.series.labelValue.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "fixed", "field", "template" - -##### obj options.series.lineColor - - -###### fn options.series.lineColor.withField - -```ts -withField(value) -``` - -fixed: T -- will be added by each element - -###### fn options.series.lineColor.withFixed - -```ts -withFixed(value) -``` - - - -##### obj options.series.lineStyle - - -###### fn options.series.lineStyle.withDash - -```ts -withDash(value) -``` - - - -###### fn options.series.lineStyle.withDashMixin - -```ts -withDashMixin(value) -``` - - - -###### fn options.series.lineStyle.withFill - -```ts -withFill(value) -``` - - - -Accepted values for `value` are "solid", "dash", "dot", "square" - -##### obj options.series.pointColor - - -###### fn options.series.pointColor.withField - -```ts -withField(value) -``` - -fixed: T -- will be added by each element - -###### fn options.series.pointColor.withFixed - -```ts -withFixed(value) -``` - - - -##### obj options.series.pointSize - - -###### fn options.series.pointSize.withField - -```ts -withField(value) -``` - -fixed: T -- will be added by each element - -###### fn options.series.pointSize.withFixed - -```ts -withFixed(value) -``` - - - -###### fn options.series.pointSize.withMax - -```ts -withMax(value) -``` - - - -###### fn options.series.pointSize.withMin - -```ts -withMin(value) -``` - - - -###### fn options.series.pointSize.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "linear", "quad" - -##### obj options.series.scaleDistribution - - -###### fn options.series.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -###### fn options.series.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -###### fn options.series.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/playlist.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/playlist.md deleted file mode 100644 index f4b3dba..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/playlist.md +++ /dev/null @@ -1,97 +0,0 @@ -# playlist - -grafonnet.playlist - -## Index - -* [`fn withInterval(value="5m")`](#fn-withinterval) -* [`fn withItems(value)`](#fn-withitems) -* [`fn withItemsMixin(value)`](#fn-withitemsmixin) -* [`fn withName(value)`](#fn-withname) -* [`fn withUid(value)`](#fn-withuid) -* [`obj items`](#obj-items) - * [`fn withTitle(value)`](#fn-itemswithtitle) - * [`fn withType(value)`](#fn-itemswithtype) - * [`fn withValue(value)`](#fn-itemswithvalue) - -## Fields - -### fn withInterval - -```ts -withInterval(value="5m") -``` - -Interval sets the time between switching views in a playlist. -FIXME: Is this based on a standardized format or what options are available? Can datemath be used? - -### fn withItems - -```ts -withItems(value) -``` - -The ordered list of items that the playlist will iterate over. -FIXME! This should not be optional, but changing it makes the godegen awkward - -### fn withItemsMixin - -```ts -withItemsMixin(value) -``` - -The ordered list of items that the playlist will iterate over. -FIXME! This should not be optional, but changing it makes the godegen awkward - -### fn withName - -```ts -withName(value) -``` - -Name of the playlist. - -### fn withUid - -```ts -withUid(value) -``` - -Unique playlist identifier. Generated on creation, either by the -creator of the playlist of by the application. - -### obj items - - -#### fn items.withTitle - -```ts -withTitle(value) -``` - -Title is an unused property -- it will be removed in the future - -#### fn items.withType - -```ts -withType(value) -``` - -Type of the item. - -Accepted values for `value` are "dashboard_by_uid", "dashboard_by_id", "dashboard_by_tag" - -#### fn items.withValue - -```ts -withValue(value) -``` - -Value depends on type and describes the playlist item. - - - dashboard_by_id: The value is an internal numerical identifier set by Grafana. This - is not portable as the numerical identifier is non-deterministic between different instances. - Will be replaced by dashboard_by_uid in the future. (deprecated) - - dashboard_by_tag: The value is a tag which is set on any number of dashboards. All - dashboards behind the tag will be added to the playlist. - - dashboard_by_uid: The value is the dashboard UID diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/preferences.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/preferences.md deleted file mode 100644 index b1f8ca7..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/preferences.md +++ /dev/null @@ -1,85 +0,0 @@ -# preferences - -grafonnet.preferences - -## Index - -* [`fn withHomeDashboardUID(value)`](#fn-withhomedashboarduid) -* [`fn withLanguage(value)`](#fn-withlanguage) -* [`fn withQueryHistory(value)`](#fn-withqueryhistory) -* [`fn withQueryHistoryMixin(value)`](#fn-withqueryhistorymixin) -* [`fn withTheme(value)`](#fn-withtheme) -* [`fn withTimezone(value)`](#fn-withtimezone) -* [`fn withWeekStart(value)`](#fn-withweekstart) -* [`obj queryHistory`](#obj-queryhistory) - * [`fn withHomeTab(value)`](#fn-queryhistorywithhometab) - -## Fields - -### fn withHomeDashboardUID - -```ts -withHomeDashboardUID(value) -``` - -UID for the home dashboard - -### fn withLanguage - -```ts -withLanguage(value) -``` - -Selected language (beta) - -### fn withQueryHistory - -```ts -withQueryHistory(value) -``` - - - -### fn withQueryHistoryMixin - -```ts -withQueryHistoryMixin(value) -``` - - - -### fn withTheme - -```ts -withTheme(value) -``` - -light, dark, empty is default - -### fn withTimezone - -```ts -withTimezone(value) -``` - -The timezone selection -TODO: this should use the timezone defined in common - -### fn withWeekStart - -```ts -withWeekStart(value) -``` - -day of the week (sunday, monday, etc) - -### obj queryHistory - - -#### fn queryHistory.withHomeTab - -```ts -withHomeTab(value) -``` - -one of: '' | 'query' | 'starred'; diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/elasticsearch.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/elasticsearch.md deleted file mode 100644 index e801793..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/elasticsearch.md +++ /dev/null @@ -1,2620 +0,0 @@ -# elasticsearch - -grafonnet.query.elasticsearch - -## Index - -* [`fn withAlias(value)`](#fn-withalias) -* [`fn withBucketAggs(value)`](#fn-withbucketaggs) -* [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withMetrics(value)`](#fn-withmetrics) -* [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) -* [`fn withQuery(value)`](#fn-withquery) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRefId(value)`](#fn-withrefid) -* [`fn withTimeField(value)`](#fn-withtimefield) -* [`obj bucketAggs`](#obj-bucketaggs) - * [`obj DateHistogram`](#obj-bucketaggsdatehistogram) - * [`fn withField(value)`](#fn-bucketaggsdatehistogramwithfield) - * [`fn withId(value)`](#fn-bucketaggsdatehistogramwithid) - * [`fn withSettings(value)`](#fn-bucketaggsdatehistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsdatehistogramwithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggsdatehistogramwithtype) - * [`obj settings`](#obj-bucketaggsdatehistogramsettings) - * [`fn withInterval(value)`](#fn-bucketaggsdatehistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-bucketaggsdatehistogramsettingswithmindoccount) - * [`fn withOffset(value)`](#fn-bucketaggsdatehistogramsettingswithoffset) - * [`fn withTimeZone(value)`](#fn-bucketaggsdatehistogramsettingswithtimezone) - * [`fn withTrimEdges(value)`](#fn-bucketaggsdatehistogramsettingswithtrimedges) - * [`obj Filters`](#obj-bucketaggsfilters) - * [`fn withId(value)`](#fn-bucketaggsfilterswithid) - * [`fn withSettings(value)`](#fn-bucketaggsfilterswithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsfilterswithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggsfilterswithtype) - * [`obj settings`](#obj-bucketaggsfilterssettings) - * [`fn withFilters(value)`](#fn-bucketaggsfilterssettingswithfilters) - * [`fn withFiltersMixin(value)`](#fn-bucketaggsfilterssettingswithfiltersmixin) - * [`obj filters`](#obj-bucketaggsfilterssettingsfilters) - * [`fn withLabel(value)`](#fn-bucketaggsfilterssettingsfilterswithlabel) - * [`fn withQuery(value)`](#fn-bucketaggsfilterssettingsfilterswithquery) - * [`obj GeoHashGrid`](#obj-bucketaggsgeohashgrid) - * [`fn withField(value)`](#fn-bucketaggsgeohashgridwithfield) - * [`fn withId(value)`](#fn-bucketaggsgeohashgridwithid) - * [`fn withSettings(value)`](#fn-bucketaggsgeohashgridwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsgeohashgridwithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggsgeohashgridwithtype) - * [`obj settings`](#obj-bucketaggsgeohashgridsettings) - * [`fn withPrecision(value)`](#fn-bucketaggsgeohashgridsettingswithprecision) - * [`obj Histogram`](#obj-bucketaggshistogram) - * [`fn withField(value)`](#fn-bucketaggshistogramwithfield) - * [`fn withId(value)`](#fn-bucketaggshistogramwithid) - * [`fn withSettings(value)`](#fn-bucketaggshistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggshistogramwithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggshistogramwithtype) - * [`obj settings`](#obj-bucketaggshistogramsettings) - * [`fn withInterval(value)`](#fn-bucketaggshistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-bucketaggshistogramsettingswithmindoccount) - * [`obj Nested`](#obj-bucketaggsnested) - * [`fn withField(value)`](#fn-bucketaggsnestedwithfield) - * [`fn withId(value)`](#fn-bucketaggsnestedwithid) - * [`fn withSettings(value)`](#fn-bucketaggsnestedwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsnestedwithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggsnestedwithtype) - * [`obj Terms`](#obj-bucketaggsterms) - * [`fn withField(value)`](#fn-bucketaggstermswithfield) - * [`fn withId(value)`](#fn-bucketaggstermswithid) - * [`fn withSettings(value)`](#fn-bucketaggstermswithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggstermswithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggstermswithtype) - * [`obj settings`](#obj-bucketaggstermssettings) - * [`fn withMinDocCount(value)`](#fn-bucketaggstermssettingswithmindoccount) - * [`fn withMissing(value)`](#fn-bucketaggstermssettingswithmissing) - * [`fn withOrder(value)`](#fn-bucketaggstermssettingswithorder) - * [`fn withOrderBy(value)`](#fn-bucketaggstermssettingswithorderby) - * [`fn withSize(value)`](#fn-bucketaggstermssettingswithsize) -* [`obj metrics`](#obj-metrics) - * [`obj Count`](#obj-metricscount) - * [`fn withHide(value)`](#fn-metricscountwithhide) - * [`fn withId(value)`](#fn-metricscountwithid) - * [`fn withType(value)`](#fn-metricscountwithtype) - * [`obj MetricAggregationWithSettings`](#obj-metricsmetricaggregationwithsettings) - * [`obj Average`](#obj-metricsmetricaggregationwithsettingsaverage) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsaveragesettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsaveragesettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingsscriptwithinline) - * [`obj BucketScript`](#obj-metricsmetricaggregationwithsettingsbucketscript) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithtype) - * [`obj pipelineVariables`](#obj-metricsmetricaggregationwithsettingsbucketscriptpipelinevariables) - * [`fn withName(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptpipelinevariableswithname) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptpipelinevariableswithpipelineagg) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricsmetricaggregationwithsettingscumulativesum) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingscumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricsmetricaggregationwithsettingsderivative) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsderivativesettings) - * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsderivativesettingswithunit) - * [`obj ExtendedStats`](#obj-metricsmetricaggregationwithsettingsextendedstats) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithid) - * [`fn withMeta(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmeta) - * [`fn withMetaMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmetamixin) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsextendedstatssettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscriptmixin) - * [`fn withSigma(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithsigma) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsextendedstatssettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingsscriptwithinline) - * [`obj Logs`](#obj-metricsmetricaggregationwithsettingslogs) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingslogswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingslogswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingslogswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingslogssettings) - * [`fn withLimit(value)`](#fn-metricsmetricaggregationwithsettingslogssettingswithlimit) - * [`obj Max`](#obj-metricsmetricaggregationwithsettingsmax) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmaxsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsmaxsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingsscriptwithinline) - * [`obj Min`](#obj-metricsmetricaggregationwithsettingsmin) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsminwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsminwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsminwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsminwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsminsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsminsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsminsettingsscriptwithinline) - * [`obj MovingAverage`](#obj-metricsmetricaggregationwithsettingsmovingaverage) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithtype) - * [`obj MovingFunction`](#obj-metricsmetricaggregationwithsettingsmovingfunction) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettings) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) - * [`fn withShift(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithshift) - * [`fn withWindow(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithwindow) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) - * [`obj Percentiles`](#obj-metricsmetricaggregationwithsettingspercentiles) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingspercentilessettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithmissing) - * [`fn withPercents(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercents) - * [`fn withPercentsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercentsmixin) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingspercentilessettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingsscriptwithinline) - * [`obj Rate`](#obj-metricsmetricaggregationwithsettingsrate) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsratewithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsratewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsratewithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsratewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsratesettings) - * [`fn withMode(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithmode) - * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithunit) - * [`obj RawData`](#obj-metricsmetricaggregationwithsettingsrawdata) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdatasettings) - * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdatasettingswithsize) - * [`obj RawDocument`](#obj-metricsmetricaggregationwithsettingsrawdocument) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdocumentsettings) - * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentsettingswithsize) - * [`obj SerialDiff`](#obj-metricsmetricaggregationwithsettingsserialdiff) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsserialdiffsettings) - * [`fn withLag(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffsettingswithlag) - * [`obj Sum`](#obj-metricsmetricaggregationwithsettingssum) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingssumwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingssumwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingssumwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingssumwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingssumsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingssumsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingssumsettingsscriptwithinline) - * [`obj TopMetrics`](#obj-metricsmetricaggregationwithsettingstopmetrics) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingstopmetricssettings) - * [`fn withMetrics(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetrics) - * [`fn withMetricsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetricsmixin) - * [`fn withOrder(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorder) - * [`fn withOrderBy(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorderby) - * [`obj UniqueCount`](#obj-metricsmetricaggregationwithsettingsuniquecount) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsuniquecountsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithmissing) - * [`fn withPrecisionThreshold(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) - * [`obj PipelineMetricAggregation`](#obj-metricspipelinemetricaggregation) - * [`obj BucketScript`](#obj-metricspipelinemetricaggregationbucketscript) - * [`fn withHide(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettingsmixin) - * [`fn withType(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithtype) - * [`obj pipelineVariables`](#obj-metricspipelinemetricaggregationbucketscriptpipelinevariables) - * [`fn withName(value)`](#fn-metricspipelinemetricaggregationbucketscriptpipelinevariableswithname) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationbucketscriptpipelinevariableswithpipelineagg) - * [`obj settings`](#obj-metricspipelinemetricaggregationbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricspipelinemetricaggregationbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricspipelinemetricaggregationcumulativesum) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithfield) - * [`fn withHide(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettingsmixin) - * [`fn withType(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationcumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricspipelinemetricaggregationcumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricspipelinemetricaggregationderivative) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationderivativewithfield) - * [`fn withHide(value)`](#fn-metricspipelinemetricaggregationderivativewithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationderivativewithsettingsmixin) - * [`fn withType(value)`](#fn-metricspipelinemetricaggregationderivativewithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationderivativesettings) - * [`fn withUnit(value)`](#fn-metricspipelinemetricaggregationderivativesettingswithunit) - * [`obj MovingAverage`](#obj-metricspipelinemetricaggregationmovingaverage) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithfield) - * [`fn withHide(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithtype) - -## Fields - -### fn withAlias - -```ts -withAlias(value) -``` - -Alias pattern - -### fn withBucketAggs - -```ts -withBucketAggs(value) -``` - -List of bucket aggregations - -### fn withBucketAggsMixin - -```ts -withBucketAggsMixin(value) -``` - -List of bucket aggregations - -### fn withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withMetrics - -```ts -withMetrics(value) -``` - -List of metric aggregations - -### fn withMetricsMixin - -```ts -withMetricsMixin(value) -``` - -List of metric aggregations - -### fn withQuery - -```ts -withQuery(value) -``` - -Lucene query - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -### fn withTimeField - -```ts -withTimeField(value) -``` - -Name of time field - -### obj bucketAggs - - -#### obj bucketAggs.DateHistogram - - -##### fn bucketAggs.DateHistogram.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.DateHistogram.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.DateHistogram.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.DateHistogram.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.DateHistogram.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.DateHistogram.settings - - -###### fn bucketAggs.DateHistogram.settings.withInterval - -```ts -withInterval(value) -``` - - - -###### fn bucketAggs.DateHistogram.settings.withMinDocCount - -```ts -withMinDocCount(value) -``` - - - -###### fn bucketAggs.DateHistogram.settings.withOffset - -```ts -withOffset(value) -``` - - - -###### fn bucketAggs.DateHistogram.settings.withTimeZone - -```ts -withTimeZone(value) -``` - - - -###### fn bucketAggs.DateHistogram.settings.withTrimEdges - -```ts -withTrimEdges(value) -``` - - - -#### obj bucketAggs.Filters - - -##### fn bucketAggs.Filters.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.Filters.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.Filters.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.Filters.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.Filters.settings - - -###### fn bucketAggs.Filters.settings.withFilters - -```ts -withFilters(value) -``` - - - -###### fn bucketAggs.Filters.settings.withFiltersMixin - -```ts -withFiltersMixin(value) -``` - - - -###### obj bucketAggs.Filters.settings.filters - - -####### fn bucketAggs.Filters.settings.filters.withLabel - -```ts -withLabel(value) -``` - - - -####### fn bucketAggs.Filters.settings.filters.withQuery - -```ts -withQuery(value) -``` - - - -#### obj bucketAggs.GeoHashGrid - - -##### fn bucketAggs.GeoHashGrid.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.GeoHashGrid.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.GeoHashGrid.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.GeoHashGrid.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.GeoHashGrid.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.GeoHashGrid.settings - - -###### fn bucketAggs.GeoHashGrid.settings.withPrecision - -```ts -withPrecision(value) -``` - - - -#### obj bucketAggs.Histogram - - -##### fn bucketAggs.Histogram.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.Histogram.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.Histogram.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.Histogram.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.Histogram.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.Histogram.settings - - -###### fn bucketAggs.Histogram.settings.withInterval - -```ts -withInterval(value) -``` - - - -###### fn bucketAggs.Histogram.settings.withMinDocCount - -```ts -withMinDocCount(value) -``` - - - -#### obj bucketAggs.Nested - - -##### fn bucketAggs.Nested.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.Nested.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.Nested.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.Nested.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.Nested.withType - -```ts -withType(value) -``` - - - -#### obj bucketAggs.Terms - - -##### fn bucketAggs.Terms.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.Terms.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.Terms.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.Terms.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.Terms.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.Terms.settings - - -###### fn bucketAggs.Terms.settings.withMinDocCount - -```ts -withMinDocCount(value) -``` - - - -###### fn bucketAggs.Terms.settings.withMissing - -```ts -withMissing(value) -``` - - - -###### fn bucketAggs.Terms.settings.withOrder - -```ts -withOrder(value) -``` - - - -Accepted values for `value` are "desc", "asc" - -###### fn bucketAggs.Terms.settings.withOrderBy - -```ts -withOrderBy(value) -``` - - - -###### fn bucketAggs.Terms.settings.withSize - -```ts -withSize(value) -``` - - - -### obj metrics - - -#### obj metrics.Count - - -##### fn metrics.Count.withHide - -```ts -withHide(value) -``` - - - -##### fn metrics.Count.withId - -```ts -withId(value) -``` - - - -##### fn metrics.Count.withType - -```ts -withType(value) -``` - - - -#### obj metrics.MetricAggregationWithSettings - - -##### obj metrics.MetricAggregationWithSettings.Average - - -###### fn metrics.MetricAggregationWithSettings.Average.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Average.settings - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Average.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Average.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.BucketScript - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables - -```ts -withPipelineVariables(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin - -```ts -withPipelineVariablesMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables.withName - -```ts -withName(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.BucketScript.settings - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.BucketScript.settings.script - - -######## fn metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.CumulativeSum - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.CumulativeSum.settings - - -####### fn metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat - -```ts -withFormat(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Derivative - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Derivative.settings - - -####### fn metrics.MetricAggregationWithSettings.Derivative.settings.withUnit - -```ts -withUnit(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.ExtendedStats - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMeta - -```ts -withMeta(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin - -```ts -withMetaMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma - -```ts -withSigma(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings.script - - -######## fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Logs - - -###### fn metrics.MetricAggregationWithSettings.Logs.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Logs.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Logs.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Logs.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Logs.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Logs.settings - - -####### fn metrics.MetricAggregationWithSettings.Logs.settings.withLimit - -```ts -withLimit(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Max - - -###### fn metrics.MetricAggregationWithSettings.Max.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Max.settings - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Max.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Max.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Min - - -###### fn metrics.MetricAggregationWithSettings.Min.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Min.settings - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Min.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Min.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.MovingAverage - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withType - -```ts -withType(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.MovingFunction - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.MovingFunction.settings - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift - -```ts -withShift(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow - -```ts -withWindow(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.MovingFunction.settings.script - - -######## fn metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Percentiles - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Percentiles.settings - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents - -```ts -withPercents(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin - -```ts -withPercentsMixin(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Percentiles.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Rate - - -###### fn metrics.MetricAggregationWithSettings.Rate.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Rate.settings - - -####### fn metrics.MetricAggregationWithSettings.Rate.settings.withMode - -```ts -withMode(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Rate.settings.withUnit - -```ts -withUnit(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.RawData - - -###### fn metrics.MetricAggregationWithSettings.RawData.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawData.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawData.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawData.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawData.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.RawData.settings - - -####### fn metrics.MetricAggregationWithSettings.RawData.settings.withSize - -```ts -withSize(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.RawDocument - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.RawDocument.settings - - -####### fn metrics.MetricAggregationWithSettings.RawDocument.settings.withSize - -```ts -withSize(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.SerialDiff - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.SerialDiff.settings - - -####### fn metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag - -```ts -withLag(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Sum - - -###### fn metrics.MetricAggregationWithSettings.Sum.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Sum.settings - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Sum.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Sum.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.TopMetrics - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.TopMetrics.settings - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics - -```ts -withMetrics(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin - -```ts -withMetricsMixin(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder - -```ts -withOrder(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy - -```ts -withOrderBy(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.UniqueCount - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.UniqueCount.settings - - -####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold - -```ts -withPrecisionThreshold(value) -``` - - - -#### obj metrics.PipelineMetricAggregation - - -##### obj metrics.PipelineMetricAggregation.BucketScript - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withId - -```ts -withId(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables - -```ts -withPipelineVariables(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin - -```ts -withPipelineVariablesMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withType - -```ts -withType(value) -``` - - - -###### obj metrics.PipelineMetricAggregation.BucketScript.pipelineVariables - - -####### fn metrics.PipelineMetricAggregation.BucketScript.pipelineVariables.withName - -```ts -withName(value) -``` - - - -####### fn metrics.PipelineMetricAggregation.BucketScript.pipelineVariables.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### obj metrics.PipelineMetricAggregation.BucketScript.settings - - -####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.PipelineMetricAggregation.BucketScript.settings.script - - -######## fn metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.PipelineMetricAggregation.CumulativeSum - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withField - -```ts -withField(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withId - -```ts -withId(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withType - -```ts -withType(value) -``` - - - -###### obj metrics.PipelineMetricAggregation.CumulativeSum.settings - - -####### fn metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat - -```ts -withFormat(value) -``` - - - -##### obj metrics.PipelineMetricAggregation.Derivative - - -###### fn metrics.PipelineMetricAggregation.Derivative.withField - -```ts -withField(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withId - -```ts -withId(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withType - -```ts -withType(value) -``` - - - -###### obj metrics.PipelineMetricAggregation.Derivative.settings - - -####### fn metrics.PipelineMetricAggregation.Derivative.settings.withUnit - -```ts -withUnit(value) -``` - - - -##### obj metrics.PipelineMetricAggregation.MovingAverage - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withField - -```ts -withField(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withId - -```ts -withId(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/index.md deleted file mode 100644 index 1ad7c17..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# query - -grafonnet.query - -## Subpackages - -* [azureMonitor](azureMonitor.md) -* [cloudWatch](cloudWatch.md) -* [elasticsearch](elasticsearch.md) -* [grafanaPyroscope](grafanaPyroscope.md) -* [loki](loki.md) -* [parca](parca.md) -* [prometheus](prometheus.md) -* [tempo](tempo.md) -* [testData](testData.md) - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/tempo.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/tempo.md deleted file mode 100644 index b39f57d..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/tempo.md +++ /dev/null @@ -1,217 +0,0 @@ -# tempo - -grafonnet.query.tempo - -## Index - -* [`fn new(datasource, query, filters)`](#fn-new) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withFilters(value)`](#fn-withfilters) -* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withLimit(value)`](#fn-withlimit) -* [`fn withMaxDuration(value)`](#fn-withmaxduration) -* [`fn withMinDuration(value)`](#fn-withminduration) -* [`fn withQuery(value)`](#fn-withquery) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRefId(value)`](#fn-withrefid) -* [`fn withSearch(value)`](#fn-withsearch) -* [`fn withServiceMapQuery(value)`](#fn-withservicemapquery) -* [`fn withServiceName(value)`](#fn-withservicename) -* [`fn withSpanName(value)`](#fn-withspanname) -* [`obj filters`](#obj-filters) - * [`fn withId(value)`](#fn-filterswithid) - * [`fn withOperator(value)`](#fn-filterswithoperator) - * [`fn withScope(value)`](#fn-filterswithscope) - * [`fn withTag(value)`](#fn-filterswithtag) - * [`fn withValue(value)`](#fn-filterswithvalue) - * [`fn withValueMixin(value)`](#fn-filterswithvaluemixin) - * [`fn withValueType(value)`](#fn-filterswithvaluetype) - -## Fields - -### fn new - -```ts -new(datasource, query, filters) -``` - -Creates a new tempo query target for panels. - -### fn withDatasource - -```ts -withDatasource(value) -``` - -Set the datasource for this query. - -### fn withFilters - -```ts -withFilters(value) -``` - - - -### fn withFiltersMixin - -```ts -withFiltersMixin(value) -``` - - - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withLimit - -```ts -withLimit(value) -``` - -Defines the maximum number of traces that are returned from Tempo - -### fn withMaxDuration - -```ts -withMaxDuration(value) -``` - -Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms - -### fn withMinDuration - -```ts -withMinDuration(value) -``` - -Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms - -### fn withQuery - -```ts -withQuery(value) -``` - -TraceQL query or trace ID - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -### fn withSearch - -```ts -withSearch(value) -``` - -Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true - -### fn withServiceMapQuery - -```ts -withServiceMapQuery(value) -``` - -Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"} - -### fn withServiceName - -```ts -withServiceName(value) -``` - -Query traces by service name - -### fn withSpanName - -```ts -withSpanName(value) -``` - -Query traces by span name - -### obj filters - - -#### fn filters.withId - -```ts -withId(value) -``` - -Uniquely identify the filter, will not be used in the query generation - -#### fn filters.withOperator - -```ts -withOperator(value) -``` - -The operator that connects the tag to the value, for example: =, >, !=, =~ - -#### fn filters.withScope - -```ts -withScope(value) -``` - -static fields are pre-set in the UI, dynamic fields are added by the user - -Accepted values for `value` are "unscoped", "resource", "span" - -#### fn filters.withTag - -```ts -withTag(value) -``` - -The tag for the search filter, for example: .http.status_code, .service.name, status - -#### fn filters.withValue - -```ts -withValue(value) -``` - -The value for the search filter - -#### fn filters.withValueMixin - -```ts -withValueMixin(value) -``` - -The value for the search filter - -#### fn filters.withValueType - -```ts -withValueType(value) -``` - -The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/serviceaccount.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/serviceaccount.md deleted file mode 100644 index 8b3bbee..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/serviceaccount.md +++ /dev/null @@ -1,120 +0,0 @@ -# serviceaccount - -grafonnet.serviceaccount - -## Index - -* [`fn withAccessControl(value)`](#fn-withaccesscontrol) -* [`fn withAccessControlMixin(value)`](#fn-withaccesscontrolmixin) -* [`fn withAvatarUrl(value)`](#fn-withavatarurl) -* [`fn withId(value)`](#fn-withid) -* [`fn withIsDisabled(value)`](#fn-withisdisabled) -* [`fn withLogin(value)`](#fn-withlogin) -* [`fn withName(value)`](#fn-withname) -* [`fn withOrgId(value)`](#fn-withorgid) -* [`fn withRole(value)`](#fn-withrole) -* [`fn withTeams(value)`](#fn-withteams) -* [`fn withTeamsMixin(value)`](#fn-withteamsmixin) -* [`fn withTokens(value)`](#fn-withtokens) - -## Fields - -### fn withAccessControl - -```ts -withAccessControl(value) -``` - -AccessControl metadata associated with a given resource. - -### fn withAccessControlMixin - -```ts -withAccessControlMixin(value) -``` - -AccessControl metadata associated with a given resource. - -### fn withAvatarUrl - -```ts -withAvatarUrl(value) -``` - -AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front -of the service account. - -### fn withId - -```ts -withId(value) -``` - -ID is the unique identifier of the service account in the database. - -### fn withIsDisabled - -```ts -withIsDisabled(value) -``` - -IsDisabled indicates if the service account is disabled. - -### fn withLogin - -```ts -withLogin(value) -``` - -Login of the service account. - -### fn withName - -```ts -withName(value) -``` - -Name of the service account. - -### fn withOrgId - -```ts -withOrgId(value) -``` - -OrgId is the ID of an organisation the service account belongs to. - -### fn withRole - -```ts -withRole(value) -``` - -OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'. - -Accepted values for `value` are "Admin", "Editor", "Viewer" - -### fn withTeams - -```ts -withTeams(value) -``` - -Teams is a list of teams the service account belongs to. - -### fn withTeamsMixin - -```ts -withTeamsMixin(value) -``` - -Teams is a list of teams the service account belongs to. - -### fn withTokens - -```ts -withTokens(value) -``` - -Tokens is the number of active tokens for the service account. -Tokens are used to authenticate the service account against Grafana. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/team.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/team.md deleted file mode 100644 index d9b935f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/team.md +++ /dev/null @@ -1,82 +0,0 @@ -# team - -grafonnet.team - -## Index - -* [`fn withAccessControl(value)`](#fn-withaccesscontrol) -* [`fn withAccessControlMixin(value)`](#fn-withaccesscontrolmixin) -* [`fn withAvatarUrl(value)`](#fn-withavatarurl) -* [`fn withEmail(value)`](#fn-withemail) -* [`fn withMemberCount(value)`](#fn-withmembercount) -* [`fn withName(value)`](#fn-withname) -* [`fn withOrgId(value)`](#fn-withorgid) -* [`fn withPermission(value)`](#fn-withpermission) - -## Fields - -### fn withAccessControl - -```ts -withAccessControl(value) -``` - -AccessControl metadata associated with a given resource. - -### fn withAccessControlMixin - -```ts -withAccessControlMixin(value) -``` - -AccessControl metadata associated with a given resource. - -### fn withAvatarUrl - -```ts -withAvatarUrl(value) -``` - -AvatarUrl is the team's avatar URL. - -### fn withEmail - -```ts -withEmail(value) -``` - -Email of the team. - -### fn withMemberCount - -```ts -withMemberCount(value) -``` - -MemberCount is the number of the team members. - -### fn withName - -```ts -withName(value) -``` - -Name of the team. - -### fn withOrgId - -```ts -withOrgId(value) -``` - -OrgId is the ID of an organisation the team belongs to. - -### fn withPermission - -```ts -withPermission(value) -``` - - - -Accepted values for `value` are 0, 1, 2, 4 diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/util.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/util.md deleted file mode 100644 index b7f621f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/util.md +++ /dev/null @@ -1,82 +0,0 @@ -# util - -Helper functions that work well with Grafonnet. - -## Index - -* [`obj dashboard`](#obj-dashboard) - * [`fn getOptionsForCustomQuery(query)`](#fn-dashboardgetoptionsforcustomquery) -* [`obj grid`](#obj-grid) - * [`fn makeGrid(panels, panelWidth, panelHeight)`](#fn-gridmakegrid) -* [`obj panel`](#obj-panel) - * [`fn setPanelIDs(panels)`](#fn-panelsetpanelids) -* [`obj string`](#obj-string) - * [`fn slugify(string)`](#fn-stringslugify) - -## Fields - -### obj dashboard - - -#### fn dashboard.getOptionsForCustomQuery - -```ts -getOptionsForCustomQuery(query) -``` - -`getOptionsForCustomQuery` provides values for the `options` and `current` fields. -These are required for template variables of type 'custom'but do not automatically -get populated by Grafana when importing a dashboard from JSON. - -This is a bit of a hack and should always be called on functions that set `type` on -a template variable (see the dashboard.templating.list veneer). Ideally Grafana -populates these fields from the `query` value but this provides a backwards -compatible solution. - - -### obj grid - - -#### fn grid.makeGrid - -```ts -makeGrid(panels, panelWidth, panelHeight) -``` - -`makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` -and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, -then all panels below it will be folded into the row. - -This function will use the full grid of 24 columns, setting `panelWidth` to a value -that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) -Other value for `panelWidth` will leave a gap on the far right. - - -### obj panel - - -#### fn panel.setPanelIDs - -```ts -setPanelIDs(panels) -``` - -`setPanelIDs` ensures that all `panels` have a unique ID, this functions is used in -`dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent -experience. - -used in ../veneer/dashboard.libsonnet - - -### obj string - - -#### fn string.slugify - -```ts -slugify(string) -``` - -`slugify` will create a simple slug from `string`, keeping only alphanumeric -characters and replacing spaces with dashes. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/grafana-version b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/grafana-version deleted file mode 100644 index b2a2d23..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/grafana-version +++ /dev/null @@ -1 +0,0 @@ -v10.0.0 \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/jsonnetfile.json b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/jsonnetfile.json deleted file mode 100644 index c3b22b3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/jsonnetfile.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "grafonnet-base" - } - }, - "version": "main" - }, - { - "source": { - "git": { - "remote": "https://github.com/grafana/grok.git", - "subdir": "jsonnet/v10.0.0" - } - }, - "version": "main" - } - ], - "legacyImports": false, - "version": 1 -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet deleted file mode 100644 index fb60978..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet +++ /dev/null @@ -1,4 +0,0 @@ -local grafonnet = import 'github.com/grafana/grafonnet/grafonnet-base/main.libsonnet'; -local schemas = import './schemas.libsonnet'; -local version = importstr './grafana-version'; -grafonnet.new(schemas, version) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/schemas.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/schemas.libsonnet deleted file mode 100644 index ae7c8fe..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/schemas.libsonnet +++ /dev/null @@ -1 +0,0 @@ -import 'github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet' diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/alerting.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/alerting.libsonnet new file mode 100644 index 0000000..621020b --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/alerting.libsonnet @@ -0,0 +1,9 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting', name: 'alerting' }, + contactPoint: import 'clean/alerting/contactPoint.libsonnet', + notificationPolicy: import 'clean/alerting/notificationPolicy.libsonnet', + muteTiming: import 'clean/alerting/muteTiming.libsonnet', + ruleGroup: import 'clean/alerting/ruleGroup.libsonnet', + messageTemplate: import 'clean/alerting/messageTemplate.libsonnet', +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/contactPoint.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/contactPoint.libsonnet new file mode 100644 index 0000000..b242533 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/contactPoint.libsonnet @@ -0,0 +1,19 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.contactPoint', name: 'contactPoint' }, + '#withDisableResolveMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDisableResolveMessage(value=true): { disableResolveMessage: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name is used as grouping key in the UI. Contact points with the\nsame name will be grouped in the UI.' } }, + withName(value): { name: value }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { provenance: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['alertmanager', ' dingding', ' discord', ' email', ' googlechat', ' kafka', ' line', ' opsgenie', ' pagerduty', ' pushover', ' sensugo', ' slack', ' teams', ' telegram', ' threema', ' victorops', ' webhook', ' wecom'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID is the unique identifier of the contact point. The UID can be\nset by the user.' } }, + withUid(value): { uid: value }, +} ++ (import '../../custom/alerting/contactPoint.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/messageTemplate.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/messageTemplate.libsonnet new file mode 100644 index 0000000..788905e --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/messageTemplate.libsonnet @@ -0,0 +1,8 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.messageTemplate', name: 'messageTemplate' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withTemplate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTemplate(value): { template: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/muteTiming.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/muteTiming.libsonnet new file mode 100644 index 0000000..f723bcd --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/muteTiming.libsonnet @@ -0,0 +1,69 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.muteTiming', name: 'muteTiming' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { time_intervals: (if std.isArray(value) + then value + else [value]) }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { time_intervals+: (if std.isArray(value) + then value + else [value]) }, + interval+: + { + '#': { help: '', name: 'interval' }, + '#withDaysOfMonth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonth(value): { days_of_month: (if std.isArray(value) + then value + else [value]) }, + '#withDaysOfMonthMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonthMixin(value): { days_of_month+: (if std.isArray(value) + then value + else [value]) }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLocation(value): { location: value }, + '#withMonths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonths(value): { months: (if std.isArray(value) + then value + else [value]) }, + '#withMonthsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonthsMixin(value): { months+: (if std.isArray(value) + then value + else [value]) }, + '#withTimes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimes(value): { times: (if std.isArray(value) + then value + else [value]) }, + '#withTimesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimesMixin(value): { times+: (if std.isArray(value) + then value + else [value]) }, + times+: + { + '#': { help: '', name: 'times' }, + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value): { from: value }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTo(value): { to: value }, + }, + '#withWeekdays': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdays(value): { weekdays: (if std.isArray(value) + then value + else [value]) }, + '#withWeekdaysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdaysMixin(value): { weekdays+: (if std.isArray(value) + then value + else [value]) }, + '#withYears': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYears(value): { years: (if std.isArray(value) + then value + else [value]) }, + '#withYearsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYearsMixin(value): { years+: (if std.isArray(value) + then value + else [value]) }, + }, +} ++ (import '../../custom/alerting/muteTiming.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/notificationPolicy.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/notificationPolicy.libsonnet new file mode 100644 index 0000000..ed0d096 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/notificationPolicy.libsonnet @@ -0,0 +1,57 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.notificationPolicy', name: 'notificationPolicy' }, + '#withContinue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withContinue(value=true): { continue: value }, + '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupInterval(value): { group_interval: value }, + '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupWait(value): { group_wait: value }, + '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRepeatInterval(value): { repeat_interval: value }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { group_by: (if std.isArray(value) + then value + else [value]) }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { group_by+: (if std.isArray(value) + then value + else [value]) }, + '#withMatchers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchers(value): { matchers: (if std.isArray(value) + then value + else [value]) }, + '#withMatchersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchersMixin(value): { matchers+: (if std.isArray(value) + then value + else [value]) }, + '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervals(value): { mute_time_intervals: (if std.isArray(value) + then value + else [value]) }, + '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervalsMixin(value): { mute_time_intervals+: (if std.isArray(value) + then value + else [value]) }, + '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withReceiver(value): { receiver: value }, + '#withRoutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutes(value): { routes: (if std.isArray(value) + then value + else [value]) }, + '#withRoutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutesMixin(value): { routes+: (if std.isArray(value) + then value + else [value]) }, + matcher+: + { + '#': { help: '', name: 'matcher' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { Name: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['=', '!=', '=~', '!~'], name: 'value', type: ['string'] }], help: 'MatchType is an enum for label matching types.' } }, + withType(value): { Type: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { Value: value }, + }, +} ++ (import '../../custom/alerting/notificationPolicy.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/ruleGroup.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/ruleGroup.libsonnet new file mode 100644 index 0000000..4106009 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/alerting/ruleGroup.libsonnet @@ -0,0 +1,75 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.ruleGroup', name: 'ruleGroup' }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { folderUid: value }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withInterval(value): { interval: value }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRules(value): { rules: (if std.isArray(value) + then value + else [value]) }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRulesMixin(value): { rules+: (if std.isArray(value) + then value + else [value]) }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { title: value }, + rule+: + { + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotations(value): { annotations: value }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotationsMixin(value): { annotations+: value }, + '#withCondition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCondition(value): { condition: value }, + '#withData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withData(value): { data: (if std.isArray(value) + then value + else [value]) }, + '#withDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDataMixin(value): { data+: (if std.isArray(value) + then value + else [value]) }, + '#withExecErrState': { 'function': { args: [{ default: null, enums: ['OK', 'Alerting', 'Error'], name: 'value', type: ['string'] }], help: '' } }, + withExecErrState(value): { execErrState: value }, + '#withFor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withFor(value): { 'for': value }, + '#withIsPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsPaused(value=true): { isPaused: value }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabels(value): { labels: value }, + '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelsMixin(value): { labels+: value }, + '#withNoDataState': { 'function': { args: [{ default: null, enums: ['Alerting', 'NoData', 'OK'], name: 'value', type: ['string'] }], help: '' } }, + withNoDataState(value): { noDataState: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { title: value }, + data+: + { + '#': { help: '', name: 'data' }, + '#withDatasourceUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation." } }, + withDatasourceUid(value): { datasourceUid: value }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModel(value): { model: value }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModelMixin(value): { model+: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { refId: value }, + '#withRelativeTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRange(value): { relativeTimeRange: value }, + '#withRelativeTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRangeMixin(value): { relativeTimeRange+: value }, + relativeTimeRange+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withFrom(value): { relativeTimeRange+: { from: value } }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withTo(value): { relativeTimeRange+: { to: value } }, + }, + }, + }, +} ++ (import '../../custom/alerting/ruleGroup.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/dashboard.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/dashboard.libsonnet new file mode 100644 index 0000000..8446c51 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/dashboard.libsonnet @@ -0,0 +1,297 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.dashboard', name: 'dashboard' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of dashboard.' } }, + withDescription(value): { description: value }, + '#withEditable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether a dashboard is editable or not.' } }, + withEditable(value=true): { editable: value }, + '#withFiscalYearStartMonth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'The month that the fiscal year starts on. 0 = January, 11 = December' } }, + withFiscalYearStartMonth(value=0): { fiscalYearStartMonth: value }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinks(value): { links: (if std.isArray(value) + then value + else [value]) }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinksMixin(value): { links+: (if std.isArray(value) + then value + else [value]) }, + '#withLiveNow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When set to true, the dashboard will redraw panels at an interval matching the pixel width.\nThis will keep data "moving left" regardless of the query refresh rate. This setting helps\navoid dashboards presenting stale live data' } }, + withLiveNow(value=true): { liveNow: value }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { panels: (if std.isArray(value) + then value + else [value]) }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { panels+: (if std.isArray(value) + then value + else [value]) }, + '#withRefresh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: 'Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d".' } }, + withRefresh(value): { refresh: value }, + '#withRefreshMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: 'Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d".' } }, + withRefreshMixin(value): { refresh+: value }, + '#withSchemaVersion': { 'function': { args: [{ default: 36, enums: null, name: 'value', type: ['integer'] }], help: 'Version of the JSON schema, incremented each time a Grafana update brings\nchanges to said schema.' } }, + withSchemaVersion(value=36): { schemaVersion: value }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTags(value): { tags: (if std.isArray(value) + then value + else [value]) }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTagsMixin(value): { tags+: (if std.isArray(value) + then value + else [value]) }, + '#withTemplating': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplating(value): { templating: value }, + '#withTemplatingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplatingMixin(value): { templating+: value }, + '#withTimezone': { 'function': { args: [{ default: 'browser', enums: null, name: 'value', type: ['string'] }], help: 'Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc".' } }, + withTimezone(value='browser'): { timezone: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title of dashboard.' } }, + withTitle(value): { title: value }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique dashboard identifier that can be generated by anyone. string (8-40)' } }, + withUid(value): { uid: value }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday".' } }, + withWeekStart(value): { weekStart: value }, + time+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value='now-6h'): { time+: { from: value } }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTo(value='now'): { time+: { to: value } }, + }, + timepicker+: + { + '#withCollapse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether timepicker is collapsed or not. Has no effect on provisioned dashboard.' } }, + withCollapse(value=true): { timepicker+: { collapse: value } }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether timepicker is visible or not.' } }, + withHidden(value=true): { timepicker+: { hidden: value } }, + '#withRefreshIntervals': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervals(value): { timepicker+: { refresh_intervals: (if std.isArray(value) + then value + else [value]) } }, + '#withRefreshIntervalsMixin': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervalsMixin(value): { timepicker+: { refresh_intervals+: (if std.isArray(value) + then value + else [value]) } }, + '#withTimeOptions': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptions(value): { timepicker+: { time_options: (if std.isArray(value) + then value + else [value]) } }, + '#withTimeOptionsMixin': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptionsMixin(value): { timepicker+: { time_options+: (if std.isArray(value) + then value + else [value]) } }, + }, + link+: + { + dashboards+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { title: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { type: value }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { tags: (if std.isArray(value) + then value + else [value]) }, + options+: + { + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { asDropdown: value }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { keepTime: value }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { includeVars: value }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { targetBlank: value }, + }, + }, + link+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { title: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { type: value }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { url: value }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { tooltip: value }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { icon: value }, + options+: + { + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { asDropdown: value }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { keepTime: value }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { includeVars: value }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { targetBlank: value }, + }, + }, + }, + annotation+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withList(value): { annotations+: { list: (if std.isArray(value) + then value + else [value]) } }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withListMixin(value): { annotations+: { list+: (if std.isArray(value) + then value + else [value]) } }, + list+: + { + '#': { help: '', name: 'list' }, + '#withBuiltIn': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Set to 1 for the standard annotation query all dashboards have by default.' } }, + withBuiltIn(value=0): { builtIn: value }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { datasource: value }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { datasource+: value }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { type: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { datasource+: { uid: value } }, + }, + '#withEnable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled the annotation query is issued with every dashboard refresh' } }, + withEnable(value=true): { enable: value }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFilter(value): { filter: value }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFilterMixin(value): { filter+: value }, + filter+: + { + '#withExclude': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Should the specified panels be included or excluded' } }, + withExclude(value=true): { filter+: { exclude: value } }, + '#withIds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIds(value): { filter+: { ids: (if std.isArray(value) + then value + else [value]) } }, + '#withIdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIdsMixin(value): { filter+: { ids+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Annotation queries can be toggled on or off at the top of the dashboard.\nWhen hide is true, the toggle is not shown in the dashboard.' } }, + withHide(value=true): { hide: value }, + '#withIconColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color to use for the annotation event markers' } }, + withIconColor(value): { iconColor: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of annotation.' } }, + withName(value): { name: value }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTarget(value): { target: value }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTargetMixin(value): { target+: value }, + target+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withLimit(value): { target+: { limit: value } }, + '#withMatchAny': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withMatchAny(value=true): { target+: { matchAny: value } }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTags(value): { target+: { tags: (if std.isArray(value) + then value + else [value]) } }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTagsMixin(value): { target+: { tags+: (if std.isArray(value) + then value + else [value]) } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withType(value): { target+: { type: value } }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TODO -- this should not exist here, it is based on the --grafana-- datasource' } }, + withType(value): { type: value }, + }, + }, + variable+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withList(value): { templating+: { list: (if std.isArray(value) + then value + else [value]) } }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withListMixin(value): { templating+: { list+: (if std.isArray(value) + then value + else [value]) } }, + list+: + { + '#': { help: '', name: 'list' }, + '#withCurrent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrent(value): { current: value }, + '#withCurrentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrentMixin(value): { current+: value }, + current+: + { + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { current+: { selected: value } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { current+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { current+: { text+: value } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { current+: { value: value } }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { current+: { value+: value } }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { datasource: value }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { datasource+: value }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { type: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { datasource+: { uid: value } }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of variable. It can be defined but `null`.' } }, + withDescription(value): { description: value }, + '#withHide': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['integer'] }], help: 'Determine if the variable shows on dashboard\nAccepted values are 0 (show label and value), 1 (show value only), 2 (show nothing).' } }, + withHide(value): { hide: value }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display name' } }, + withLabel(value): { label: value }, + '#withMulti': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether multiple values can be selected or not from variable value list' } }, + withMulti(value=true): { multi: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of variable' } }, + withName(value): { name: value }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptions(value): { options: (if std.isArray(value) + then value + else [value]) }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptionsMixin(value): { options+: (if std.isArray(value) + then value + else [value]) }, + options+: + { + '#': { help: '', name: 'options' }, + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { selected: value }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { text: value }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { text+: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { value: value }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { value+: value }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQuery(value): { query: value }, + '#withQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQueryMixin(value): { query+: value }, + '#withRefresh': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['integer'] }], help: 'Options to config when to refresh a variable\n`0`: Never refresh the variable\n`1`: Queries the data source every time the dashboard loads.\n`2`: Queries the data source when the dashboard time range changes.' } }, + withRefresh(value): { refresh: value }, + '#withSkipUrlSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the variable value should be managed by URL query params or not' } }, + withSkipUrlSync(value=true): { skipUrlSync: value }, + '#withSort': { 'function': { args: [{ default: null, enums: [0, 1, 2, 3, 4, 5, 6], name: 'value', type: ['integer'] }], help: 'Sort variable options\nAccepted values are:\n`0`: No sorting\n`1`: Alphabetical ASC\n`2`: Alphabetical DESC\n`3`: Numerical ASC\n`4`: Numerical DESC\n`5`: Alphabetical Case Insensitive ASC\n`6`: Alphabetical Case Insensitive DESC' } }, + withSort(value): { sort: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['query', 'adhoc', 'constant', 'datasource', 'interval', 'textbox', 'custom', 'system'], name: 'value', type: ['string'] }], help: 'Dashboard variable type\n`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.\n`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).\n`constant`: \tDefine a hidden constant.\n`datasource`: Quickly change the data source for an entire dashboard.\n`interval`: Interval variables represent time spans.\n`textbox`: Display a free text input field with an optional default value.\n`custom`: Define the variable options manually using a comma-separated list.\n`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables' } }, + withType(value): { type: value }, + }, + }, +} ++ (import '../custom/dashboard.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel.libsonnet new file mode 100644 index 0000000..f167953 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel.libsonnet @@ -0,0 +1,348 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + panelOptions+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel title.' } }, + withTitle(value): { title: value }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description.' } }, + withDescription(value): { description: value }, + '#withTransparent': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether to display the panel without a background.' } }, + withTransparent(value=true): { transparent: value }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinks(value): { links: (if std.isArray(value) + then value + else [value]) }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinksMixin(value): { links+: (if std.isArray(value) + then value + else [value]) }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { repeat: value }, + '#withRepeatDirection': { 'function': { args: [{ default: 'h', enums: ['h', 'v'], name: 'value', type: ['string'] }], help: "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical." } }, + withRepeatDirection(value='h'): { repeatDirection: value }, + '#withPluginVersion': { 'function': { args: [], help: '' } }, + withPluginVersion(): { pluginVersion: 'v10.2.0' }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel plugin type id. This is used to find the plugin to display the panel.' } }, + withType(value): { type: value }, + link+: + { + '#': { help: '', name: 'link' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { asDropdown: value }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { icon: value }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { includeVars: value }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { keepTime: value }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { tags: (if std.isArray(value) + then value + else [value]) }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { tags+: (if std.isArray(value) + then value + else [value]) }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { targetBlank: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { title: value }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { tooltip: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { type: value }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { url: value }, + }, + }, + queryOptions+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { datasource: value }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { datasource+: value }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum number of data points that the panel queries are retrieving.' } }, + withMaxDataPoints(value): { maxDataPoints: value }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: "40s", "3d", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withInterval(value): { interval: value }, + '#withTimeFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeFrom(value): { timeFrom: value }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeShift(value): { timeShift: value }, + '#withTargets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargets(value): { targets: (if std.isArray(value) + then value + else [value]) }, + '#withTargetsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargetsMixin(value): { targets+: (if std.isArray(value) + then value + else [value]) }, + '#withTransformations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformations(value): { transformations: (if std.isArray(value) + then value + else [value]) }, + '#withTransformationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformationsMixin(value): { transformations+: (if std.isArray(value) + then value + else [value]) }, + transformation+: + { + '#': { help: '', name: 'transformation' }, + '#withDisabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Disabled transformations are skipped' } }, + withDisabled(value=true): { disabled: value }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilter(value): { filter: value }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilterMixin(value): { filter+: value }, + filter+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { filter+: { id: value } }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { filter+: { options: value } }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique identifier of transformer' } }, + withId(value): { id: value }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptions(value): { options: value }, + }, + }, + standardOptions+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:` for custom unit that should go after value.\n`prefix:` for custom unit that should go before value.\n`time:` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.\n`count:` for a custom count unit.\n`currency:` for custom a currency unit.' } }, + withUnit(value): { fieldConfig+: { defaults+: { unit: value } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMin(value): { fieldConfig+: { defaults+: { min: value } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMax(value): { fieldConfig+: { defaults+: { max: value } } }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`.' } }, + withDecimals(value): { fieldConfig+: { defaults+: { decimals: value } } }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The display value for this field. This supports template variables blank is auto' } }, + withDisplayName(value): { fieldConfig+: { defaults+: { displayName: value } } }, + color+: + { + '#withFixedColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The fixed color value for fixed or shades color modes.' } }, + withFixedColor(value): { fieldConfig+: { defaults+: { color+: { fixedColor: value } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['thresholds', 'palette-classic', 'palette-classic-by-name', 'continuous-GrYlRd', 'continuous-RdYlGr', 'continuous-BlYlRd', 'continuous-YlRd', 'continuous-BlPu', 'continuous-YlBl', 'continuous-blues', 'continuous-reds', 'continuous-greens', 'continuous-purples', 'fixed', 'shades'], name: 'value', type: ['string'] }], help: 'Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations\n`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule.' } }, + withMode(value): { fieldConfig+: { defaults+: { color+: { mode: value } } } }, + '#withSeriesBy': { 'function': { args: [{ default: null, enums: ['min', 'max', 'last'], name: 'value', type: ['string'] }], help: 'Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.' } }, + withSeriesBy(value): { fieldConfig+: { defaults+: { color+: { seriesBy: value } } } }, + }, + '#withNoValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alternative to empty string' } }, + withNoValue(value): { fieldConfig+: { defaults+: { noValue: value } } }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinks(value): { fieldConfig+: { defaults+: { links: (if std.isArray(value) + then value + else [value]) } } }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinksMixin(value): { fieldConfig+: { defaults+: { links+: (if std.isArray(value) + then value + else [value]) } } }, + '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappings(value): { fieldConfig+: { defaults+: { mappings: (if std.isArray(value) + then value + else [value]) } } }, + '#withMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappingsMixin(value): { fieldConfig+: { defaults+: { mappings+: (if std.isArray(value) + then value + else [value]) } } }, + '#withOverrides': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverrides(value): { fieldConfig+: { overrides: (if std.isArray(value) + then value + else [value]) } }, + '#withOverridesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverridesMixin(value): { fieldConfig+: { overrides+: (if std.isArray(value) + then value + else [value]) } }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source field supports ad-hoc filters' } }, + withFilterable(value=true): { fieldConfig+: { defaults+: { filterable: value } } }, + '#withPath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results' } }, + withPath(value): { fieldConfig+: { defaults+: { path: value } } }, + thresholds+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['absolute', 'percentage'], name: 'value', type: ['string'] }], help: 'Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).' } }, + withMode(value): { fieldConfig+: { defaults+: { thresholds+: { mode: value } } } }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withSteps(value): { fieldConfig+: { defaults+: { thresholds+: { steps: (if std.isArray(value) + then value + else [value]) } } } }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withStepsMixin(value): { fieldConfig+: { defaults+: { thresholds+: { steps+: (if std.isArray(value) + then value + else [value]) } } } }, + }, + mapping+: + { + '#': { help: '', name: 'mapping' }, + ValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptionsMixin(value): { options+: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + RangeMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'null'] }], help: 'Min value of the range. It can be null which means -Infinity' } }, + withFrom(value): { options+: { from: value } }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { options+: { result: value } }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { options+: { result+: value } }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { options+: { result+: { color: value } } }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { options+: { result+: { icon: value } } }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { options+: { result+: { index: value } } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { options+: { result+: { text: value } } }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'null'] }], help: 'Max value of the range. It can be null which means +Infinity' } }, + withTo(value): { options+: { to: value } }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + RegexMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withPattern': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Regular expression to match against' } }, + withPattern(value): { options+: { pattern: value } }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { options+: { result: value } }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { options+: { result+: value } }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { options+: { result+: { color: value } } }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { options+: { result+: { icon: value } } }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { options+: { result+: { index: value } } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { options+: { result+: { text: value } } }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + SpecialValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withMatch': { 'function': { args: [{ default: null, enums: ['true', 'false', 'null', 'nan', 'null+nan', 'empty'], name: 'value', type: ['string'] }], help: 'Special value types supported by the `SpecialValueMap`' } }, + withMatch(value): { options+: { match: value } }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { options+: { result: value } }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { options+: { result+: value } }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { options+: { result+: { color: value } } }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { options+: { result+: { icon: value } } }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { options+: { result+: { index: value } } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { options+: { result+: { text: value } } }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + }, + threshold+: + { + step+: + { + '#': { help: '', name: 'step' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.' } }, + withColor(value): { color: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'null'] }], help: 'Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON.' } }, + withValue(value): { value: value }, + }, + }, + override+: + { + '#': { help: '', name: 'override' }, + '#withMatcher': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcher(value): { matcher: value }, + '#withMatcherMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcherMixin(value): { matcher+: value }, + matcher+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { matcher+: { id: value } }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { matcher+: { options: value } }, + }, + '#withProperties': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withProperties(value): { properties: (if std.isArray(value) + then value + else [value]) }, + '#withPropertiesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPropertiesMixin(value): { properties+: (if std.isArray(value) + then value + else [value]) }, + properties+: + { + '#': { help: '', name: 'properties' }, + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value=''): { id: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { value: value }, + }, + }, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { type: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { datasource+: { uid: value } }, + }, + libraryPanel+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel name' } }, + withName(value): { libraryPanel+: { name: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel uid' } }, + withUid(value): { libraryPanel+: { uid: value } }, + }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { gridPos+: { h: value } }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { gridPos+: { static: value } }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { gridPos+: { w: value } }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { gridPos+: { x: value } }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { gridPos+: { y: value } }, + }, +} ++ (import '../custom/panel.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/alertGroups.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/alertGroups.libsonnet new file mode 100644 index 0000000..b75d7cc --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/alertGroups.libsonnet @@ -0,0 +1,20 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.alertGroups', name: 'alertGroups' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'alertGroups' }, + }, + options+: + { + '#withAlertmanager': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the alertmanager used as a source for alerts' } }, + withAlertmanager(value): { options+: { alertmanager: value } }, + '#withExpandAll': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Expand all alert groups by default' } }, + withExpandAll(value=true): { options+: { expandAll: value } }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Comma-separated list of values used to filter alert results' } }, + withLabels(value): { options+: { labels: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/alertList.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/alertList.libsonnet new file mode 100644 index 0000000..ebdd898 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/alertList.libsonnet @@ -0,0 +1,125 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.alertList', name: 'alertList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'alertlist' }, + }, + options+: + { + '#withAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptions(value): { options+: { AlertListOptions: value } }, + '#withAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptionsMixin(value): { options+: { AlertListOptions+: value } }, + AlertListOptions+: + { + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { options+: { alertName: value } }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { options+: { dashboardAlerts: value } }, + '#withDashboardTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDashboardTitle(value): { options+: { dashboardTitle: value } }, + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFolderId(value): { options+: { folderId: value } }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { options+: { maxItems: value } }, + '#withShowOptions': { 'function': { args: [{ default: null, enums: ['current', 'changes'], name: 'value', type: ['string'] }], help: '' } }, + withShowOptions(value): { options+: { showOptions: value } }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { options+: { sortOrder: value } }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { options+: { stateFilter: value } }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { options+: { stateFilter+: value } }, + stateFilter+: + { + '#withAlerting': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAlerting(value=true): { options+: { stateFilter+: { alerting: value } } }, + '#withExecutionError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withExecutionError(value=true): { options+: { stateFilter+: { execution_error: value } } }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { options+: { stateFilter+: { no_data: value } } }, + '#withOk': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOk(value=true): { options+: { stateFilter+: { ok: value } } }, + '#withPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPaused(value=true): { options+: { stateFilter+: { paused: value } } }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { options+: { stateFilter+: { pending: value } } }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { options+: { tags: (if std.isArray(value) + then value + else [value]) } }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { options+: { tags+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withUnifiedAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptions(value): { options+: { UnifiedAlertListOptions: value } }, + '#withUnifiedAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptionsMixin(value): { options+: { UnifiedAlertListOptions+: value } }, + UnifiedAlertListOptions+: + { + '#withAlertInstanceLabelFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertInstanceLabelFilter(value): { options+: { alertInstanceLabelFilter: value } }, + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { options+: { alertName: value } }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { options+: { dashboardAlerts: value } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDatasource(value): { options+: { datasource: value } }, + '#withFolder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolder(value): { options+: { folder: value } }, + '#withFolderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolderMixin(value): { options+: { folder+: value } }, + folder+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withId(value): { options+: { folder+: { id: value } } }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { options+: { folder+: { title: value } } }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { options+: { groupBy: (if std.isArray(value) + then value + else [value]) } }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { options+: { groupBy+: (if std.isArray(value) + then value + else [value]) } }, + '#withGroupMode': { 'function': { args: [{ default: null, enums: ['default', 'custom'], name: 'value', type: ['string'] }], help: '' } }, + withGroupMode(value): { options+: { groupMode: value } }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { options+: { maxItems: value } }, + '#withShowInstances': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowInstances(value=true): { options+: { showInstances: value } }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { options+: { sortOrder: value } }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { options+: { stateFilter: value } }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { options+: { stateFilter+: value } }, + stateFilter+: + { + '#withError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withError(value=true): { options+: { stateFilter+: { 'error': value } } }, + '#withFiring': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFiring(value=true): { options+: { stateFilter+: { firing: value } } }, + '#withInactive': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInactive(value=true): { options+: { stateFilter+: { inactive: value } } }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { options+: { stateFilter+: { noData: value } } }, + '#withNormal': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNormal(value=true): { options+: { stateFilter+: { normal: value } } }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { options+: { stateFilter+: { pending: value } } }, + }, + '#withViewMode': { 'function': { args: [{ default: null, enums: ['list', 'stat'], name: 'value', type: ['string'] }], help: '' } }, + withViewMode(value): { options+: { viewMode: value } }, + }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/annotationsList.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/annotationsList.libsonnet new file mode 100644 index 0000000..de40766 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/annotationsList.libsonnet @@ -0,0 +1,40 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.annotationsList', name: 'annotationsList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'annolist' }, + }, + options+: + { + '#withLimit': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLimit(value=10): { options+: { limit: value } }, + '#withNavigateAfter': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateAfter(value='10m'): { options+: { navigateAfter: value } }, + '#withNavigateBefore': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateBefore(value='10m'): { options+: { navigateBefore: value } }, + '#withNavigateToPanel': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNavigateToPanel(value=true): { options+: { navigateToPanel: value } }, + '#withOnlyFromThisDashboard': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyFromThisDashboard(value=true): { options+: { onlyFromThisDashboard: value } }, + '#withOnlyInTimeRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyInTimeRange(value=true): { options+: { onlyInTimeRange: value } }, + '#withShowTags': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTags(value=true): { options+: { showTags: value } }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { options+: { showTime: value } }, + '#withShowUser': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUser(value=true): { options+: { showUser: value } }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { options+: { tags: (if std.isArray(value) + then value + else [value]) } }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { options+: { tags+: (if std.isArray(value) + then value + else [value]) } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/barChart.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/barChart.libsonnet new file mode 100644 index 0000000..6d6bd44 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/barChart.libsonnet @@ -0,0 +1,159 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.barChart', name: 'barChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'barchart' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.\nGradient appearance is influenced by the Fill opacity setting.' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle: value } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: value } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: { mode: value } } } } }, + }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withBarRadius': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Controls the radius of each bar.' } }, + withBarRadius(value=0): { options+: { barRadius: value } }, + '#withBarWidth': { 'function': { args: [{ default: 0.96999999999999997, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of bars. 1 = Max width, 0 = Min width.' } }, + withBarWidth(value=0.96999999999999997): { options+: { barWidth: value } }, + '#withColorByField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use the color value for a sibling field to color each bar value.' } }, + withColorByField(value): { options+: { colorByField: value } }, + '#withFullHighlight': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enables mode which highlights the entire bar area and shows tooltip when cursor\nhovers over highlighted area' } }, + withFullHighlight(value=true): { options+: { fullHighlight: value } }, + '#withGroupWidth': { 'function': { args: [{ default: 0.69999999999999996, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of groups. 1 = max with, 0 = min width.' } }, + withGroupWidth(value=0.69999999999999996): { options+: { groupWidth: value } }, + '#withOrientation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the orientation of the bar chart, either vertical or horizontal.' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withShowValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'This controls whether values are shown on top or to the left of bars.' } }, + withShowValue(value): { options+: { showValue: value } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls whether bars are stacked or not, either normally or in percent mode.' } }, + withStacking(value): { options+: { stacking: value } }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Manually select which field from the dataset to represent the x field.' } }, + withXField(value): { options+: { xField: value } }, + '#withXTickLabelMaxLength': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the max length that a label can have before it is truncated.' } }, + withXTickLabelMaxLength(value): { options+: { xTickLabelMaxLength: value } }, + '#withXTickLabelRotation': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the rotation of the x axis labels.' } }, + withXTickLabelRotation(value=0): { options+: { xTickLabelRotation: value } }, + '#withXTickLabelSpacing': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the spacing between x axis labels.\nnegative values indicate backwards skipping behavior' } }, + withXTickLabelSpacing(value=0): { options+: { xTickLabelSpacing: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/barGauge.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/barGauge.libsonnet new file mode 100644 index 0000000..641449d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/barGauge.libsonnet @@ -0,0 +1,60 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.barGauge', name: 'barGauge' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'bargauge' }, + }, + options+: + { + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { options+: { reduceOptions: value } }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { options+: { reduceOptions+: value } }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { options+: { reduceOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { options+: { reduceOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { options+: { reduceOptions+: { fields: value } } }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { options+: { reduceOptions+: { limit: value } } }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { options+: { reduceOptions+: { values: value } } }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withDisplayMode(value): { options+: { displayMode: value } }, + '#withMinVizHeight': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=10): { options+: { minVizHeight: value } }, + '#withMinVizWidth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=0): { options+: { minVizWidth: value } }, + '#withNamePlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'left'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge name to be placed explicitly' } }, + withNamePlacement(value): { options+: { namePlacement: value } }, + '#withShowUnfilled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUnfilled(value=true): { options+: { showUnfilled: value } }, + '#withValueMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueMode(value): { options+: { valueMode: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/candlestick.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/candlestick.libsonnet new file mode 100644 index 0000000..34bf6d9 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/candlestick.libsonnet @@ -0,0 +1,216 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.candlestick', name: 'candlestick' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'candlestick' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { lineColor: value } } } }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { fieldConfig+: { defaults+: { custom+: { lineInterpolation: value } } } }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { lineStyle: value } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: value } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { fill: value } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { fieldConfig+: { defaults+: { custom+: { spanNulls: value } } } }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { fieldConfig+: { defaults+: { custom+: { spanNulls+: value } } } }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { fieldConfig+: { defaults+: { custom+: { fillBelowTo: value } } } }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { fieldConfig+: { defaults+: { custom+: { fillColor: value } } } }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { pointColor: value } } } }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { pointSize: value } } } }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { fieldConfig+: { defaults+: { custom+: { pointSymbol: value } } } }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { fieldConfig+: { defaults+: { custom+: { showPoints: value } } } }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['integer'] }], help: 'TODO docs' } }, + withBarAlignment(value): { fieldConfig+: { defaults+: { custom+: { barAlignment: value } } } }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { fieldConfig+: { defaults+: { custom+: { barMaxWidth: value } } } }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { fieldConfig+: { defaults+: { custom+: { barWidthFactor: value } } } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { fieldConfig+: { defaults+: { custom+: { stacking: value } } } }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { fieldConfig+: { defaults+: { custom+: { stacking+: value } } } }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { group: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { mode: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { fieldConfig+: { defaults+: { custom+: { drawStyle: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle: value } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: value } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: { mode: value } } } } }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { fieldConfig+: { defaults+: { custom+: { transform: value } } } }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withCandleStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the style of the candlesticks' } }, + withCandleStyle(value): { options+: { candleStyle: value } }, + '#withColorStrategy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the color strategy for the candlesticks' } }, + withColorStrategy(value): { options+: { colorStrategy: value } }, + '#withColors': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColors(value): { options+: { colors: value } }, + '#withColorsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorsMixin(value): { options+: { colors+: value } }, + colors+: + { + '#withDown': { 'function': { args: [{ default: 'red', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDown(value='red'): { options+: { colors+: { down: value } } }, + '#withFlat': { 'function': { args: [{ default: 'gray', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFlat(value='gray'): { options+: { colors+: { flat: value } } }, + '#withUp': { 'function': { args: [{ default: 'green', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUp(value='green'): { options+: { colors+: { up: value } } }, + }, + '#withFields': { 'function': { args: [{ default: {}, enums: null, name: 'value', type: ['object'] }], help: 'Map fields to appropriate dimension' } }, + withFields(value={}): { options+: { fields: value } }, + '#withFieldsMixin': { 'function': { args: [{ default: {}, enums: null, name: 'value', type: ['object'] }], help: 'Map fields to appropriate dimension' } }, + withFieldsMixin(value): { options+: { fields+: value } }, + fields+: + { + '#withCandlestickFieldMap': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCandlestickFieldMap(value): { options+: { fields+: { CandlestickFieldMap: value } } }, + '#withCandlestickFieldMapMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCandlestickFieldMapMixin(value): { options+: { fields+: { CandlestickFieldMap+: value } } }, + CandlestickFieldMap+: + { + '#withClose': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the final (end) value of the given period' } }, + withClose(value): { options+: { fields+: { close: value } } }, + '#withHigh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the highest value of the given period' } }, + withHigh(value): { options+: { fields+: { high: value } } }, + '#withLow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the lowest value of the given period' } }, + withLow(value): { options+: { fields+: { low: value } } }, + '#withOpen': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the starting value of the given period' } }, + withOpen(value): { options+: { fields+: { open: value } } }, + '#withVolume': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the sample count in the given period. (e.g. number of trades)' } }, + withVolume(value): { options+: { fields+: { volume: value } } }, + }, + }, + '#withIncludeAllFields': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled, all fields will be sent to the graph' } }, + withIncludeAllFields(value=true): { options+: { includeAllFields: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets which dimensions are used for the visualization' } }, + withMode(value): { options+: { mode: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/canvas.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/canvas.libsonnet new file mode 100644 index 0000000..b862c46 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/canvas.libsonnet @@ -0,0 +1,196 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.canvas', name: 'canvas' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'canvas' }, + }, + options+: + { + '#withInlineEditing': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable inline editing' } }, + withInlineEditing(value=true): { options+: { inlineEditing: value } }, + '#withRoot': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRoot(value): { options+: { root: value } }, + '#withRootMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRootMixin(value): { options+: { root+: value } }, + root+: + { + '#withElements': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElements(value): { options+: { root+: { elements: (if std.isArray(value) + then value + else [value]) } } }, + '#withElementsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElementsMixin(value): { options+: { root+: { elements+: (if std.isArray(value) + then value + else [value]) } } }, + elements+: + { + '#': { help: '', name: 'elements' }, + '#withBackground': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackground(value): { background: value }, + '#withBackgroundMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackgroundMixin(value): { background+: value }, + background+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { background+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { background+: { color+: value } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { background+: { color+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { background+: { color+: { fixed: value } } }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImage(value): { background+: { image: value } }, + '#withImageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImageMixin(value): { background+: { image+: value } }, + image+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { background+: { image+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { background+: { image+: { fixed: value } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'mapping'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { background+: { image+: { mode: value } } }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: ['original', 'contain', 'cover', 'fill', 'tile'], name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { background+: { size: value } }, + }, + '#withBorder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorder(value): { border: value }, + '#withBorderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorderMixin(value): { border+: value }, + border+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { border+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { border+: { color+: value } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { border+: { color+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { border+: { color+: { fixed: value } } }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { border+: { width: value } }, + }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfig(value): { config: value }, + '#withConnections': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnections(value): { connections: (if std.isArray(value) + then value + else [value]) }, + '#withConnectionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnectionsMixin(value): { connections+: (if std.isArray(value) + then value + else [value]) }, + connections+: + { + '#': { help: '', name: 'connections' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { color: value }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { color+: value }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { color+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { color+: { fixed: value } }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: ['straight'], name: 'value', type: ['string'] }], help: '' } }, + withPath(value): { path: value }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSize(value): { size: value }, + '#withSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSizeMixin(value): { size+: value }, + size+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { size+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { size+: { fixed: value } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { size+: { max: value } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { size+: { min: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { size+: { mode: value } }, + }, + '#withSource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSource(value): { source: value }, + '#withSourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceMixin(value): { source+: value }, + source+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { source+: { x: value } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { source+: { y: value } }, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTarget(value): { target: value }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetMixin(value): { target+: value }, + target+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { target+: { x: value } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { target+: { y: value } }, + }, + '#withTargetName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTargetName(value): { targetName: value }, + }, + '#withConstraint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraint(value): { constraint: value }, + '#withConstraintMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraintMixin(value): { constraint+: value }, + constraint+: + { + '#withHorizontal': { 'function': { args: [{ default: null, enums: ['left', 'right', 'leftright', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withHorizontal(value): { constraint+: { horizontal: value } }, + '#withVertical': { 'function': { args: [{ default: null, enums: ['top', 'bottom', 'topbottom', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withVertical(value): { constraint+: { vertical: value } }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withPlacement': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacement(value): { placement: value }, + '#withPlacementMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacementMixin(value): { placement+: value }, + placement+: + { + '#withBottom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBottom(value): { placement+: { bottom: value } }, + '#withHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withHeight(value): { placement+: { height: value } }, + '#withLeft': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLeft(value): { placement+: { left: value } }, + '#withRight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRight(value): { placement+: { right: value } }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTop(value): { placement+: { top: value } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { placement+: { width: value } }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the root element' } }, + withName(value): { options+: { root+: { name: value } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['frame'], name: 'value', type: ['string'] }], help: 'Type of root element (frame)' } }, + withType(value): { options+: { root+: { type: value } } }, + }, + '#withShowAdvancedTypes': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show all available element types' } }, + withShowAdvancedTypes(value=true): { options+: { showAdvancedTypes: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/dashboardList.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/dashboardList.libsonnet new file mode 100644 index 0000000..bf02b01 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/dashboardList.libsonnet @@ -0,0 +1,42 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.dashboardList', name: 'dashboardList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'dashlist' }, + }, + options+: + { + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'folderId is deprecated, and migrated to folderUid on panel init' } }, + withFolderId(value): { options+: { folderId: value } }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { options+: { folderUID: value } }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIncludeVars(value=true): { options+: { includeVars: value } }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withKeepTime(value=true): { options+: { keepTime: value } }, + '#withMaxItems': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxItems(value=10): { options+: { maxItems: value } }, + '#withQuery': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value=''): { options+: { query: value } }, + '#withShowHeadings': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowHeadings(value=true): { options+: { showHeadings: value } }, + '#withShowRecentlyViewed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowRecentlyViewed(value=true): { options+: { showRecentlyViewed: value } }, + '#withShowSearch': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowSearch(value=true): { options+: { showSearch: value } }, + '#withShowStarred': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowStarred(value=true): { options+: { showStarred: value } }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { options+: { tags: (if std.isArray(value) + then value + else [value]) } }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { options+: { tags+: (if std.isArray(value) + then value + else [value]) } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/datagrid.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/datagrid.libsonnet new file mode 100644 index 0000000..7f30ddb --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/datagrid.libsonnet @@ -0,0 +1,16 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.datagrid', name: 'datagrid' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'datagrid' }, + }, + options+: + { + '#withSelectedSeries': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSelectedSeries(value=0): { options+: { selectedSeries: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/debug.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/debug.libsonnet new file mode 100644 index 0000000..82c8cfb --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/debug.libsonnet @@ -0,0 +1,29 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.debug', name: 'debug' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'debug' }, + }, + options+: + { + '#withCounters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCounters(value): { options+: { counters: value } }, + '#withCountersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCountersMixin(value): { options+: { counters+: value } }, + counters+: + { + '#withDataChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDataChanged(value=true): { options+: { counters+: { dataChanged: value } } }, + '#withRender': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRender(value=true): { options+: { counters+: { render: value } } }, + '#withSchemaChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSchemaChanged(value=true): { options+: { counters+: { schemaChanged: value } } }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['render', 'events', 'cursor', 'State', 'ThrowError'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { mode: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/gauge.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/gauge.libsonnet new file mode 100644 index 0000000..32b2dfe --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/gauge.libsonnet @@ -0,0 +1,56 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.gauge', name: 'gauge' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'gauge' }, + }, + options+: + { + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { options+: { reduceOptions: value } }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { options+: { reduceOptions+: value } }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { options+: { reduceOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { options+: { reduceOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { options+: { reduceOptions+: { fields: value } } }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { options+: { reduceOptions+: { limit: value } } }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { options+: { reduceOptions+: { values: value } } }, + }, + '#withMinVizHeight': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=75): { options+: { minVizHeight: value } }, + '#withMinVizWidth': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=75): { options+: { minVizWidth: value } }, + '#withShowThresholdLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdLabels(value=true): { options+: { showThresholdLabels: value } }, + '#withShowThresholdMarkers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdMarkers(value=true): { options+: { showThresholdMarkers: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/geomap.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/geomap.libsonnet new file mode 100644 index 0000000..623ef62 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/geomap.libsonnet @@ -0,0 +1,156 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.geomap', name: 'geomap' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'geomap' }, + }, + options+: + { + '#withBasemap': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemap(value): { options+: { basemap: value } }, + '#withBasemapMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemapMixin(value): { options+: { basemap+: value } }, + basemap+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { options+: { basemap+: { config: value } } }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { options+: { basemap+: { filterData: value } } }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocation(value): { options+: { basemap+: { location: value } } }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocationMixin(value): { options+: { basemap+: { location+: value } } }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { options+: { basemap+: { location+: { gazetteer: value } } } }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { options+: { basemap+: { location+: { geohash: value } } } }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { options+: { basemap+: { location+: { latitude: value } } } }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { options+: { basemap+: { location+: { longitude: value } } } }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { options+: { basemap+: { location+: { lookup: value } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { basemap+: { location+: { mode: value } } } }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { options+: { basemap+: { location+: { wkt: value } } } }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { options+: { basemap+: { name: value } } }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { options+: { basemap+: { opacity: value } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { options+: { basemap+: { tooltip: value } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { options+: { basemap+: { type: value } } }, + }, + '#withControls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControls(value): { options+: { controls: value } }, + '#withControlsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControlsMixin(value): { options+: { controls+: value } }, + controls+: + { + '#withMouseWheelZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'let the mouse wheel zoom' } }, + withMouseWheelZoom(value=true): { options+: { controls+: { mouseWheelZoom: value } } }, + '#withShowAttribution': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Lower right' } }, + withShowAttribution(value=true): { options+: { controls+: { showAttribution: value } } }, + '#withShowDebug': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show debug' } }, + withShowDebug(value=true): { options+: { controls+: { showDebug: value } } }, + '#withShowMeasure': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show measure' } }, + withShowMeasure(value=true): { options+: { controls+: { showMeasure: value } } }, + '#withShowScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Scale options' } }, + withShowScale(value=true): { options+: { controls+: { showScale: value } } }, + '#withShowZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Zoom (upper left)' } }, + withShowZoom(value=true): { options+: { controls+: { showZoom: value } } }, + }, + '#withLayers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayers(value): { options+: { layers: (if std.isArray(value) + then value + else [value]) } }, + '#withLayersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayersMixin(value): { options+: { layers+: (if std.isArray(value) + then value + else [value]) } }, + layers+: + { + '#': { help: '', name: 'layers' }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { config: value }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { filterData: value }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocation(value): { location: value }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocationMixin(value): { location+: value }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { location+: { gazetteer: value } }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { location+: { geohash: value } }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { location+: { latitude: value } }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { location+: { longitude: value } }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { location+: { lookup: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { location+: { mode: value } }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { location+: { wkt: value } }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { name: value }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { opacity: value }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { tooltip: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'details'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withView(value): { options+: { view: value } }, + '#withViewMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withViewMixin(value): { options+: { view+: value } }, + view+: + { + '#withAllLayers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAllLayers(value=true): { options+: { view+: { allLayers: value } } }, + '#withId': { 'function': { args: [{ default: 'zero', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value='zero'): { options+: { view+: { id: value } } }, + '#withLastOnly': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLastOnly(value=true): { options+: { view+: { lastOnly: value } } }, + '#withLat': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLat(value=0): { options+: { view+: { lat: value } } }, + '#withLayer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLayer(value): { options+: { view+: { layer: value } } }, + '#withLon': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLon(value=0): { options+: { view+: { lon: value } } }, + '#withMaxZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxZoom(value): { options+: { view+: { maxZoom: value } } }, + '#withMinZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinZoom(value): { options+: { view+: { minZoom: value } } }, + '#withPadding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withPadding(value): { options+: { view+: { padding: value } } }, + '#withShared': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShared(value=true): { options+: { view+: { shared: value } } }, + '#withZoom': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withZoom(value=1): { options+: { view+: { zoom: value } } }, + }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/heatmap.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/heatmap.libsonnet new file mode 100644 index 0000000..d4fd585 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/heatmap.libsonnet @@ -0,0 +1,268 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.heatmap', name: 'heatmap' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'heatmap' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + }, + }, + }, + options+: + { + '#withCalculate': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the heatmap should be calculated from data' } }, + withCalculate(value=true): { options+: { calculate: value } }, + '#withCalculation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCalculation(value): { options+: { calculation: value } }, + '#withCalculationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCalculationMixin(value): { options+: { calculation+: value } }, + calculation+: + { + '#withXBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXBuckets(value): { options+: { calculation+: { xBuckets: value } } }, + '#withXBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXBucketsMixin(value): { options+: { calculation+: { xBuckets+: value } } }, + xBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { calculation+: { xBuckets+: { mode: value } } } }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { options+: { calculation+: { xBuckets+: { scale: value } } } }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { options+: { calculation+: { xBuckets+: { scale+: value } } } }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { options+: { calculation+: { xBuckets+: { scale+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { options+: { calculation+: { xBuckets+: { scale+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { options+: { calculation+: { xBuckets+: { scale+: { type: value } } } } }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { options+: { calculation+: { xBuckets+: { value: value } } } }, + }, + '#withYBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withYBuckets(value): { options+: { calculation+: { yBuckets: value } } }, + '#withYBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withYBucketsMixin(value): { options+: { calculation+: { yBuckets+: value } } }, + yBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { calculation+: { yBuckets+: { mode: value } } } }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { options+: { calculation+: { yBuckets+: { scale: value } } } }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { options+: { calculation+: { yBuckets+: { scale+: value } } } }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { options+: { calculation+: { yBuckets+: { scale+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { options+: { calculation+: { yBuckets+: { scale+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { options+: { calculation+: { yBuckets+: { scale+: { type: value } } } } }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { options+: { calculation+: { yBuckets+: { value: value } } } }, + }, + }, + '#withCellGap': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls gap between cells' } }, + withCellGap(value=1): { options+: { cellGap: value } }, + '#withCellRadius': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls cell radius' } }, + withCellRadius(value): { options+: { cellRadius: value } }, + '#withCellValues': { 'function': { args: [{ default: {}, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value unit' } }, + withCellValues(value={}): { options+: { cellValues: value } }, + '#withCellValuesMixin': { 'function': { args: [{ default: {}, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value unit' } }, + withCellValuesMixin(value): { options+: { cellValues+: value } }, + cellValues+: + { + '#withCellValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValues(value): { options+: { cellValues+: { CellValues: value } } }, + '#withCellValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValuesMixin(value): { options+: { cellValues+: { CellValues+: value } } }, + CellValues+: + { + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for cell values' } }, + withDecimals(value): { options+: { cellValues+: { decimals: value } } }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the cell value unit' } }, + withUnit(value): { options+: { cellValues+: { unit: value } } }, + }, + }, + '#withColor': { 'function': { args: [{ default: { exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }, enums: null, name: 'value', type: ['object'] }], help: 'Controls the color options' } }, + withColor(value={ exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }): { options+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: { exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }, enums: null, name: 'value', type: ['object'] }], help: 'Controls the color options' } }, + withColorMixin(value): { options+: { color+: value } }, + color+: + { + '#withHeatmapColorOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withHeatmapColorOptions(value): { options+: { color+: { HeatmapColorOptions: value } } }, + '#withHeatmapColorOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withHeatmapColorOptionsMixin(value): { options+: { color+: { HeatmapColorOptions+: value } } }, + HeatmapColorOptions+: + { + '#withExponent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the exponent when scale is set to exponential' } }, + withExponent(value): { options+: { color+: { exponent: value } } }, + '#withFill': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color fill when in opacity mode' } }, + withFill(value): { options+: { color+: { fill: value } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the color scale' } }, + withMax(value): { options+: { color+: { max: value } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the color scale' } }, + withMin(value): { options+: { color+: { min: value } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['opacity', 'scheme'], name: 'value', type: ['string'] }], help: 'Controls the color mode of the heatmap' } }, + withMode(value): { options+: { color+: { mode: value } } }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the color scheme' } }, + withReverse(value=true): { options+: { color+: { reverse: value } } }, + '#withScale': { 'function': { args: [{ default: null, enums: ['linear', 'exponential'], name: 'value', type: ['string'] }], help: 'Controls the color scale of the heatmap' } }, + withScale(value): { options+: { color+: { scale: value } } }, + '#withScheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color scheme used' } }, + withScheme(value): { options+: { color+: { scheme: value } } }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the number of color steps' } }, + withSteps(value): { options+: { color+: { steps: value } } }, + }, + }, + '#withExemplars': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplars(value): { options+: { exemplars: value } }, + '#withExemplarsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplarsMixin(value): { options+: { exemplars+: value } }, + exemplars+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the color of the exemplar markers' } }, + withColor(value): { options+: { exemplars+: { color: value } } }, + }, + '#withFilterValues': { 'function': { args: [{ default: { le: 1.0000000000000001e-09 }, enums: null, name: 'value', type: ['object'] }], help: 'Filters values between a given range' } }, + withFilterValues(value={ le: 1.0000000000000001e-09 }): { options+: { filterValues: value } }, + '#withFilterValuesMixin': { 'function': { args: [{ default: { le: 1.0000000000000001e-09 }, enums: null, name: 'value', type: ['object'] }], help: 'Filters values between a given range' } }, + withFilterValuesMixin(value): { options+: { filterValues+: value } }, + filterValues+: + { + '#withFilterValueRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValueRange(value): { options+: { filterValues+: { FilterValueRange: value } } }, + '#withFilterValueRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValueRangeMixin(value): { options+: { filterValues+: { FilterValueRange+: value } } }, + FilterValueRange+: + { + '#withGe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values greater than or equal to the given value' } }, + withGe(value): { options+: { filterValues+: { ge: value } } }, + '#withLe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values less than or equal to the given value' } }, + withLe(value): { options+: { filterValues+: { le: value } } }, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the legend is shown' } }, + withShow(value=true): { options+: { legend+: { show: value } } }, + }, + '#withRowsFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrame(value): { options+: { rowsFrame: value } }, + '#withRowsFrameMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrameMixin(value): { options+: { rowsFrame+: value } }, + rowsFrame+: + { + '#withLayout': { 'function': { args: [{ default: null, enums: ['le', 'ge', 'unknown', 'auto'], name: 'value', type: ['string'] }], help: '' } }, + withLayout(value): { options+: { rowsFrame+: { layout: value } } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the name of the cell when not calculating from data' } }, + withValue(value): { options+: { rowsFrame+: { value: value } } }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '| *{\n\tlayout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed\n}\nControls the display of the value in the cell' } }, + withShowValue(value): { options+: { showValue: value } }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip is shown' } }, + withShow(value=true): { options+: { tooltip+: { show: value } } }, + '#withYHistogram': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a histogram of the y-axis values' } }, + withYHistogram(value=true): { options+: { tooltip+: { yHistogram: value } } }, + }, + '#withYAxis': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxis(value): { options+: { yAxis: value } }, + '#withYAxisMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxisMixin(value): { options+: { yAxis+: value } }, + yAxis+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { options+: { yAxis+: { axisBorderShow: value } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { options+: { yAxis+: { axisCenteredZero: value } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { options+: { yAxis+: { axisColorMode: value } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { options+: { yAxis+: { axisGridShow: value } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { options+: { yAxis+: { axisLabel: value } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { options+: { yAxis+: { axisPlacement: value } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { options+: { yAxis+: { axisSoftMax: value } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { options+: { yAxis+: { axisSoftMin: value } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { options+: { yAxis+: { axisWidth: value } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { options+: { yAxis+: { scaleDistribution: value } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { options+: { yAxis+: { scaleDistribution+: value } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { options+: { yAxis+: { scaleDistribution+: { linearThreshold: value } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { options+: { yAxis+: { scaleDistribution+: { log: value } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { options+: { yAxis+: { scaleDistribution+: { type: value } } } }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for yAxis values' } }, + withDecimals(value): { options+: { yAxis+: { decimals: value } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the yAxis' } }, + withMax(value): { options+: { yAxis+: { max: value } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the yAxis' } }, + withMin(value): { options+: { yAxis+: { min: value } } }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the yAxis' } }, + withReverse(value=true): { options+: { yAxis+: { reverse: value } } }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the yAxis unit' } }, + withUnit(value): { options+: { yAxis+: { unit: value } } }, + }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/histogram.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/histogram.libsonnet new file mode 100644 index 0000000..91c988d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/histogram.libsonnet @@ -0,0 +1,121 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.histogram', name: 'histogram' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'histogram' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.\nGradient appearance is influenced by the Fill opacity setting.' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withBucketOffset': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Offset buckets by this amount' } }, + withBucketOffset(value=0): { options+: { bucketOffset: value } }, + '#withBucketSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Size of each bucket' } }, + withBucketSize(value): { options+: { bucketSize: value } }, + '#withCombine': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Combines multiple series into a single histogram' } }, + withCombine(value=true): { options+: { combine: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/logs.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/logs.libsonnet new file mode 100644 index 0000000..2788182 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/logs.libsonnet @@ -0,0 +1,30 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.logs', name: 'logs' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'logs' }, + }, + options+: + { + '#withDedupStrategy': { 'function': { args: [{ default: null, enums: ['none', 'exact', 'numbers', 'signature'], name: 'value', type: ['string'] }], help: '' } }, + withDedupStrategy(value): { options+: { dedupStrategy: value } }, + '#withEnableLogDetails': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnableLogDetails(value=true): { options+: { enableLogDetails: value } }, + '#withPrettifyLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPrettifyLogMessage(value=true): { options+: { prettifyLogMessage: value } }, + '#withShowCommonLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowCommonLabels(value=true): { options+: { showCommonLabels: value } }, + '#withShowLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLabels(value=true): { options+: { showLabels: value } }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { options+: { showTime: value } }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: ['Descending', 'Ascending'], name: 'value', type: ['string'] }], help: '' } }, + withSortOrder(value): { options+: { sortOrder: value } }, + '#withWrapLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWrapLogMessage(value=true): { options+: { wrapLogMessage: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/news.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/news.libsonnet new file mode 100644 index 0000000..03112ba --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/news.libsonnet @@ -0,0 +1,18 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.news', name: 'news' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'news' }, + }, + options+: + { + '#withFeedUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'empty/missing will default to grafana blog' } }, + withFeedUrl(value): { options+: { feedUrl: value } }, + '#withShowImage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowImage(value=true): { options+: { showImage: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/nodeGraph.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/nodeGraph.libsonnet new file mode 100644 index 0000000..4d74ff1 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/nodeGraph.libsonnet @@ -0,0 +1,52 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.nodeGraph', name: 'nodeGraph' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'nodeGraph' }, + }, + options+: + { + '#withEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdges(value): { options+: { edges: value } }, + '#withEdgesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdgesMixin(value): { options+: { edges+: value } }, + edges+: + { + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { options+: { edges+: { mainStatUnit: value } } }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { options+: { edges+: { secondaryStatUnit: value } } }, + }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { options+: { nodes: value } }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { options+: { nodes+: value } }, + nodes+: + { + '#withArcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcs(value): { options+: { nodes+: { arcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withArcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcsMixin(value): { options+: { nodes+: { arcs+: (if std.isArray(value) + then value + else [value]) } } }, + arcs+: + { + '#': { help: '', name: 'arcs' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The color of the arc.' } }, + withColor(value): { color: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field from which to get the value. Values should be less than 1, representing fraction of a circle.' } }, + withField(value): { field: value }, + }, + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { options+: { nodes+: { mainStatUnit: value } } }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { options+: { nodes+: { secondaryStatUnit: value } } }, + }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/pieChart.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/pieChart.libsonnet new file mode 100644 index 0000000..c39153a --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/pieChart.libsonnet @@ -0,0 +1,130 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.pieChart', name: 'pieChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'piechart' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + }, + }, + }, + options+: + { + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { options+: { reduceOptions: value } }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { options+: { reduceOptions+: value } }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { options+: { reduceOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { options+: { reduceOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { options+: { reduceOptions+: { fields: value } } }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { options+: { reduceOptions+: { limit: value } } }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { options+: { reduceOptions+: { values: value } } }, + }, + '#withDisplayLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabels(value): { options+: { displayLabels: (if std.isArray(value) + then value + else [value]) } }, + '#withDisplayLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabelsMixin(value): { options+: { displayLabels+: (if std.isArray(value) + then value + else [value]) } }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + '#withValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValues(value): { options+: { legend+: { values: (if std.isArray(value) + then value + else [value]) } } }, + '#withValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValuesMixin(value): { options+: { legend+: { values+: (if std.isArray(value) + then value + else [value]) } } }, + }, + '#withPieType': { 'function': { args: [{ default: null, enums: ['pie', 'donut'], name: 'value', type: ['string'] }], help: 'Select the pie chart display style.' } }, + withPieType(value): { options+: { pieType: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/stat.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/stat.libsonnet new file mode 100644 index 0000000..b974b15 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/stat.libsonnet @@ -0,0 +1,56 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.stat', name: 'stat' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'stat' }, + }, + options+: + { + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { options+: { reduceOptions: value } }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { options+: { reduceOptions+: value } }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { options+: { reduceOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { options+: { reduceOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { options+: { reduceOptions+: { fields: value } } }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { options+: { reduceOptions+: { limit: value } } }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { options+: { reduceOptions+: { values: value } } }, + }, + '#withColorMode': { 'function': { args: [{ default: null, enums: ['value', 'background', 'background_solid', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withColorMode(value): { options+: { colorMode: value } }, + '#withGraphMode': { 'function': { args: [{ default: null, enums: ['none', 'line', 'area'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGraphMode(value): { options+: { graphMode: value } }, + '#withJustifyMode': { 'function': { args: [{ default: null, enums: ['auto', 'center'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withJustifyMode(value): { options+: { justifyMode: value } }, + '#withTextMode': { 'function': { args: [{ default: null, enums: ['auto', 'value', 'value_and_name', 'name', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTextMode(value): { options+: { textMode: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/stateTimeline.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/stateTimeline.libsonnet new file mode 100644 index 0000000..72b8fd5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/stateTimeline.libsonnet @@ -0,0 +1,98 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.stateTimeline', name: 'stateTimeline' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'state-timeline' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withLineWidth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=0): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { options+: { timezone: (if std.isArray(value) + then value + else [value]) } }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { options+: { timezone+: (if std.isArray(value) + then value + else [value]) } }, + '#withAlignValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls value alignment on the timelines' } }, + withAlignValue(value): { options+: { alignValue: value } }, + '#withMergeValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Merge equal consecutive values' } }, + withMergeValues(value=true): { options+: { mergeValues: value } }, + '#withRowHeight': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Controls the row height' } }, + withRowHeight(value=0.90000000000000002): { options+: { rowHeight: value } }, + '#withShowValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Show timeline values on chart' } }, + withShowValue(value): { options+: { showValue: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/statusHistory.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/statusHistory.libsonnet new file mode 100644 index 0000000..8d3b77b --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/statusHistory.libsonnet @@ -0,0 +1,96 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.statusHistory', name: 'statusHistory' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'status-history' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=1): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { options+: { timezone: (if std.isArray(value) + then value + else [value]) } }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { options+: { timezone+: (if std.isArray(value) + then value + else [value]) } }, + '#withColWidth': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Controls the column width' } }, + withColWidth(value=0.90000000000000002): { options+: { colWidth: value } }, + '#withRowHeight': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Set the height of the rows' } }, + withRowHeight(value=0.90000000000000002): { options+: { rowHeight: value } }, + '#withShowValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Show values on the columns' } }, + withShowValue(value): { options+: { showValue: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/table.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/table.libsonnet new file mode 100644 index 0000000..695afd9 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/table.libsonnet @@ -0,0 +1,294 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.table', name: 'table' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'table' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withAlign': { 'function': { args: [{ default: null, enums: ['auto', 'left', 'right', 'center'], name: 'value', type: ['string'] }], help: 'TODO -- should not be table specific!\nTODO docs' } }, + withAlign(value): { fieldConfig+: { defaults+: { custom+: { align: value } } } }, + '#withCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions: value } } } }, + '#withCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: value } } } }, + cellOptions+: + { + '#withTableAutoCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableAutoCellOptions: value } } } } }, + '#withTableAutoCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableAutoCellOptions+: value } } } } }, + TableAutoCellOptions+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableSparklineCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableSparklineCellOptions: value } } } } }, + '#withTableSparklineCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableSparklineCellOptions+: value } } } } }, + TableSparklineCellOptions+: + { + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineColor: value } } } } }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineInterpolation: value } } } } }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle: value } } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle+: value } } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle+: { fill: value } } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineWidth: value } } } } }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { spanNulls: value } } } } }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { spanNulls+: value } } } } }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { fillBelowTo: value } } } } }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { fillColor: value } } } } }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { fillOpacity: value } } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { pointColor: value } } } } }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { pointSize: value } } } } }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { pointSymbol: value } } } } }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { showPoints: value } } } } }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisBorderShow: value } } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisCenteredZero: value } } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisColorMode: value } } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisGridShow: value } } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisLabel: value } } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisPlacement: value } } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisSoftMax: value } } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisSoftMin: value } } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisWidth: value } } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution: value } } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution+: value } } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution+: { linearThreshold: value } } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution+: { log: value } } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution+: { type: value } } } } } }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['integer'] }], help: 'TODO docs' } }, + withBarAlignment(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { barAlignment: value } } } } }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { barMaxWidth: value } } } } }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { barWidthFactor: value } } } } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { stacking: value } } } } }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { stacking+: value } } } } }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { stacking+: { group: value } } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { stacking+: { mode: value } } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom: value } } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom+: value } } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom+: { legend: value } } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom+: { tooltip: value } } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom+: { viz: value } } } } } }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { drawStyle: value } } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { gradientMode: value } } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { thresholdsStyle: value } } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { thresholdsStyle+: value } } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { thresholdsStyle+: { mode: value } } } } } }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { transform: value } } } } }, + '#withHideValue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHideValue(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideValue: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableBarGaugeCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableBarGaugeCellOptions: value } } } } }, + '#withTableBarGaugeCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableBarGaugeCellOptions+: value } } } } }, + TableBarGaugeCellOptions+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { mode: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + '#withValueDisplayMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueDisplayMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { valueDisplayMode: value } } } } }, + }, + '#withTableColoredBackgroundCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableColoredBackgroundCellOptions: value } } } } }, + '#withTableColoredBackgroundCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableColoredBackgroundCellOptions+: value } } } } }, + TableColoredBackgroundCellOptions+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'gradient'], name: 'value', type: ['string'] }], help: 'Display mode to the "Colored Background" display\nmode for table cells. Either displays a solid color (basic mode)\nor a gradient.' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { mode: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableColorTextCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableColorTextCellOptions: value } } } } }, + '#withTableColorTextCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableColorTextCellOptions+: value } } } } }, + TableColorTextCellOptions+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableImageCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableImageCellOptions: value } } } } }, + '#withTableImageCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableImageCellOptions+: value } } } } }, + TableImageCellOptions+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableJsonViewCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableJsonViewCellOptions: value } } } } }, + '#withTableJsonViewCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableJsonViewCellOptions+: value } } } } }, + TableJsonViewCellOptions+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['auto', 'color-text', 'color-background', 'color-background-solid', 'gradient-gauge', 'lcd-gauge', 'json-view', 'basic', 'image', 'gauge', 'sparkline', 'custom'], name: 'value', type: ['string'] }], help: "Internally, this is the \"type\" of cell that's being displayed\nin the table such as colored text, JSON, gauge, etc.\nThe color-background-solid, gradient-gauge, and lcd-gauge\nmodes are deprecated in favor of new cell subOptions" } }, + withDisplayMode(value): { fieldConfig+: { defaults+: { custom+: { displayMode: value } } } }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFilterable(value=true): { fieldConfig+: { defaults+: { custom+: { filterable: value } } } }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHidden(value=true): { fieldConfig+: { defaults+: { custom+: { hidden: value } } } }, + '#withHideHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Hides any header for a column, useful for columns that show some static content or buttons.' } }, + withHideHeader(value=true): { fieldConfig+: { defaults+: { custom+: { hideHeader: value } } } }, + '#withInspect': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInspect(value=true): { fieldConfig+: { defaults+: { custom+: { inspect: value } } } }, + '#withMinWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMinWidth(value): { fieldConfig+: { defaults+: { custom+: { minWidth: value } } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { fieldConfig+: { defaults+: { custom+: { width: value } } } }, + }, + }, + }, + options+: + { + '#withCellHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the height of the rows' } }, + withCellHeight(value): { options+: { cellHeight: value } }, + '#withFooter': { 'function': { args: [{ default: { countRows: false, reducer: [], show: false }, enums: null, name: 'value', type: ['object'] }], help: 'Controls footer options' } }, + withFooter(value={ countRows: false, reducer: [], show: false }): { options+: { footer: value } }, + '#withFooterMixin': { 'function': { args: [{ default: { countRows: false, reducer: [], show: false }, enums: null, name: 'value', type: ['object'] }], help: 'Controls footer options' } }, + withFooterMixin(value): { options+: { footer+: value } }, + footer+: + { + '#withTableFooterOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withTableFooterOptions(value): { options+: { footer+: { TableFooterOptions: value } } }, + '#withTableFooterOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withTableFooterOptionsMixin(value): { options+: { footer+: { TableFooterOptions+: value } } }, + TableFooterOptions+: + { + '#withCountRows': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withCountRows(value=true): { options+: { footer+: { countRows: value } } }, + '#withEnablePagination': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnablePagination(value=true): { options+: { footer+: { enablePagination: value } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { options+: { footer+: { fields: (if std.isArray(value) + then value + else [value]) } } }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { options+: { footer+: { fields+: (if std.isArray(value) + then value + else [value]) } } }, + '#withReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withReducer(value): { options+: { footer+: { reducer: (if std.isArray(value) + then value + else [value]) } } }, + '#withReducerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withReducerMixin(value): { options+: { footer+: { reducer+: (if std.isArray(value) + then value + else [value]) } } }, + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShow(value=true): { options+: { footer+: { show: value } } }, + }, + }, + '#withFrameIndex': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Represents the index of the selected frame' } }, + withFrameIndex(value=0): { options+: { frameIndex: value } }, + '#withShowHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the panel should show the header' } }, + withShowHeader(value=true): { options+: { showHeader: value } }, + '#withShowTypeIcons': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the header should show icons for the column types' } }, + withShowTypeIcons(value=true): { options+: { showTypeIcons: value } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortBy(value): { options+: { sortBy: (if std.isArray(value) + then value + else [value]) } }, + '#withSortByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortByMixin(value): { options+: { sortBy+: (if std.isArray(value) + then value + else [value]) } }, + sortBy+: + { + '#': { help: '', name: 'sortBy' }, + '#withDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag used to indicate descending sort order' } }, + withDesc(value=true): { desc: value }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the display name of the field to sort by' } }, + withDisplayName(value): { displayName: value }, + }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/text.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/text.libsonnet new file mode 100644 index 0000000..04f7c28 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/text.libsonnet @@ -0,0 +1,31 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.text', name: 'text' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'text' }, + }, + options+: + { + '#withCode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCode(value): { options+: { code: value } }, + '#withCodeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCodeMixin(value): { options+: { code+: value } }, + code+: + { + '#withLanguage': { 'function': { args: [{ default: 'plaintext', enums: ['plaintext', 'yaml', 'xml', 'typescript', 'sql', 'go', 'markdown', 'html', 'json'], name: 'value', type: ['string'] }], help: '' } }, + withLanguage(value='plaintext'): { options+: { code+: { language: value } } }, + '#withShowLineNumbers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLineNumbers(value=true): { options+: { code+: { showLineNumbers: value } } }, + '#withShowMiniMap': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowMiniMap(value=true): { options+: { code+: { showMiniMap: value } } }, + }, + '#withContent': { 'function': { args: [{ default: '# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withContent(value='# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)'): { options+: { content: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['html', 'markdown', 'code'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { mode: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/timeSeries.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/timeSeries.libsonnet new file mode 100644 index 0000000..5e595c7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/timeSeries.libsonnet @@ -0,0 +1,190 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.timeSeries', name: 'timeSeries' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'timeseries' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { lineColor: value } } } }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { fieldConfig+: { defaults+: { custom+: { lineInterpolation: value } } } }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { lineStyle: value } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: value } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { fill: value } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { fieldConfig+: { defaults+: { custom+: { spanNulls: value } } } }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { fieldConfig+: { defaults+: { custom+: { spanNulls+: value } } } }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { fieldConfig+: { defaults+: { custom+: { fillBelowTo: value } } } }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { fieldConfig+: { defaults+: { custom+: { fillColor: value } } } }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { pointColor: value } } } }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { pointSize: value } } } }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { fieldConfig+: { defaults+: { custom+: { pointSymbol: value } } } }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { fieldConfig+: { defaults+: { custom+: { showPoints: value } } } }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['integer'] }], help: 'TODO docs' } }, + withBarAlignment(value): { fieldConfig+: { defaults+: { custom+: { barAlignment: value } } } }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { fieldConfig+: { defaults+: { custom+: { barMaxWidth: value } } } }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { fieldConfig+: { defaults+: { custom+: { barWidthFactor: value } } } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { fieldConfig+: { defaults+: { custom+: { stacking: value } } } }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { fieldConfig+: { defaults+: { custom+: { stacking+: value } } } }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { group: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { mode: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { fieldConfig+: { defaults+: { custom+: { drawStyle: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle: value } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: value } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: { mode: value } } } } }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { fieldConfig+: { defaults+: { custom+: { transform: value } } } }, + }, + }, + }, + options+: + { + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { options+: { timezone: (if std.isArray(value) + then value + else [value]) } }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { options+: { timezone+: (if std.isArray(value) + then value + else [value]) } }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/trend.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/trend.libsonnet new file mode 100644 index 0000000..23fa89c --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/trend.libsonnet @@ -0,0 +1,184 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.trend', name: 'trend' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'trend' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { lineColor: value } } } }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { fieldConfig+: { defaults+: { custom+: { lineInterpolation: value } } } }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { lineStyle: value } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: value } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { fill: value } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { fieldConfig+: { defaults+: { custom+: { spanNulls: value } } } }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { fieldConfig+: { defaults+: { custom+: { spanNulls+: value } } } }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { fieldConfig+: { defaults+: { custom+: { fillBelowTo: value } } } }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { fieldConfig+: { defaults+: { custom+: { fillColor: value } } } }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { pointColor: value } } } }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { pointSize: value } } } }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { fieldConfig+: { defaults+: { custom+: { pointSymbol: value } } } }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { fieldConfig+: { defaults+: { custom+: { showPoints: value } } } }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['integer'] }], help: 'TODO docs' } }, + withBarAlignment(value): { fieldConfig+: { defaults+: { custom+: { barAlignment: value } } } }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { fieldConfig+: { defaults+: { custom+: { barMaxWidth: value } } } }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { fieldConfig+: { defaults+: { custom+: { barWidthFactor: value } } } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { fieldConfig+: { defaults+: { custom+: { stacking: value } } } }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { fieldConfig+: { defaults+: { custom+: { stacking+: value } } } }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { group: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { mode: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { fieldConfig+: { defaults+: { custom+: { drawStyle: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle: value } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: value } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: { mode: value } } } } }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { fieldConfig+: { defaults+: { custom+: { transform: value } } } }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the x field to use (defaults to first number)' } }, + withXField(value): { options+: { xField: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/xyChart.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/xyChart.libsonnet new file mode 100644 index 0000000..edb4a2d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/panel/xyChart.libsonnet @@ -0,0 +1,342 @@ +// This file is generated, do not manually edit. +(import '../../clean/panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.xyChart', name: 'xyChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'xychart' }, + }, + fieldConfig+: + { + defaults+: + { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { fieldConfig+: { defaults+: { custom+: { label: value } } } }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { fieldConfig+: { defaults+: { custom+: { labelValue: value } } } }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { fieldConfig+: { defaults+: { custom+: { labelValue+: value } } } }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { fieldConfig+: { defaults+: { custom+: { labelValue+: { field: value } } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { fieldConfig+: { defaults+: { custom+: { labelValue+: { fixed: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { labelValue+: { mode: value } } } } }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { lineColor: value } } } }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { fieldConfig+: { defaults+: { custom+: { lineColor+: value } } } }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { fieldConfig+: { defaults+: { custom+: { lineColor+: { field: value } } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { fieldConfig+: { defaults+: { custom+: { lineColor+: { fixed: value } } } } }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { lineStyle: value } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: value } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { fill: value } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { pointColor: value } } } }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { fieldConfig+: { defaults+: { custom+: { pointColor+: value } } } }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { fieldConfig+: { defaults+: { custom+: { pointColor+: { field: value } } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { fieldConfig+: { defaults+: { custom+: { pointColor+: { fixed: value } } } } }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { pointSize: value } } } }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: value } } } }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { field: value } } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { fixed: value } } } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { max: value } } } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { min: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { mode: value } } } } }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { fieldConfig+: { defaults+: { custom+: { show: value } } } }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withDims': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDims(value): { options+: { dims: value } }, + '#withDimsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDimsMixin(value): { options+: { dims+: value } }, + dims+: + { + '#withExclude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExclude(value): { options+: { dims+: { exclude: (if std.isArray(value) + then value + else [value]) } } }, + '#withExcludeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExcludeMixin(value): { options+: { dims+: { exclude+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFrame(value): { options+: { dims+: { frame: value } } }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { options+: { dims+: { x: value } } }, + }, + '#withSeries': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withSeries(value): { options+: { series: (if std.isArray(value) + then value + else [value]) } }, + '#withSeriesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withSeriesMixin(value): { options+: { series+: (if std.isArray(value) + then value + else [value]) } }, + series+: + { + '#': { help: '', name: 'series' }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { hideFrom: value }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { hideFrom+: value }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { hideFrom+: { legend: value } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { hideFrom+: { tooltip: value } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { hideFrom+: { viz: value } }, + }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { axisBorderShow: value }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { axisCenteredZero: value }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { axisColorMode: value }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { axisGridShow: value }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { axisLabel: value }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { axisPlacement: value }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { axisSoftMax: value }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { axisSoftMin: value }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { axisWidth: value }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { scaleDistribution: value }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { scaleDistribution+: value }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { scaleDistribution+: { linearThreshold: value } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { scaleDistribution+: { log: value } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { scaleDistribution+: { type: value } }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { label: value }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { labelValue: value }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { labelValue+: value }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { labelValue+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { labelValue+: { fixed: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { labelValue+: { mode: value } }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { lineColor: value }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { lineColor+: value }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { lineColor+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { lineColor+: { fixed: value } }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { lineStyle: value }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { lineStyle+: value }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { lineStyle+: { fill: value } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { lineWidth: value }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { pointColor: value }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { pointColor+: value }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { pointColor+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { pointColor+: { fixed: value } }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { pointSize: value }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { pointSize+: value }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { pointSize+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { pointSize+: { fixed: value } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { pointSize+: { max: value } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { pointSize+: { min: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { pointSize+: { mode: value } }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { show: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { x: value }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withY(value): { y: value }, + }, + '#withSeriesMapping': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: '' } }, + withSeriesMapping(value): { options+: { seriesMapping: value } }, + }, +} ++ { panelOptions+: { '#withType':: {} } } diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/loki.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/loki.libsonnet new file mode 100644 index 0000000..510a5d8 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/loki.libsonnet @@ -0,0 +1,29 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.loki', name: 'loki' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { editorMode: value }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The LogQL query.' } }, + withExpr(value): { expr: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, + withInstant(value=true): { instant: value }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to override the name of the series.' } }, + withLegendFormat(value): { legendFormat: value }, + '#withMaxLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Used to limit the number of log rows returned.' } }, + withMaxLines(value): { maxLines: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, + withRange(value=true): { range: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withResolution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '@deprecated, now use step.' } }, + withResolution(value): { resolution: value }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to set step value for range queries.' } }, + withStep(value): { step: value }, +} ++ (import '../../custom/query/loki.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/prometheus.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/prometheus.libsonnet new file mode 100644 index 0000000..3413105 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/prometheus.libsonnet @@ -0,0 +1,29 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.prometheus', name: 'prometheus' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { editorMode: value }, + '#withExemplar': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Execute an additional query to identify interesting raw samples relevant for the given expr' } }, + withExemplar(value=true): { exemplar: value }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The actual expression/query that will be evaluated by Prometheus' } }, + withExpr(value): { expr: value }, + '#withFormat': { 'function': { args: [{ default: null, enums: ['time_series', 'table', 'heatmap'], name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { format: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns only the latest value that Prometheus has scraped for the requested time series' } }, + withInstant(value=true): { instant: value }, + '#withIntervalFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '@deprecated Used to specify how many times to divide max data points by. We use max data points under query options\nSee https://github.com/grafana/grafana/issues/48081' } }, + withIntervalFactor(value): { intervalFactor: value }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname' } }, + withLegendFormat(value): { legendFormat: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series' } }, + withRange(value=true): { range: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, +} ++ (import '../../custom/query/prometheus.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/tempo.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/tempo.libsonnet new file mode 100644 index 0000000..19cb958 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/clean/query/tempo.libsonnet @@ -0,0 +1,87 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.tempo', name: 'tempo' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { filters: (if std.isArray(value) + then value + else [value]) }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { filters+: (if std.isArray(value) + then value + else [value]) }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { id: value }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { operator: value }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { scope: value }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { tag: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { value: value }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { value+: value }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { valueType: value }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupBy(value): { groupBy: (if std.isArray(value) + then value + else [value]) }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupByMixin(value): { groupBy+: (if std.isArray(value) + then value + else [value]) }, + groupBy+: + { + '#': { help: '', name: 'groupBy' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { id: value }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { operator: value }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { scope: value }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { tag: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { value: value }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { value+: value }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { valueType: value }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of traces that are returned from Tempo' } }, + withLimit(value): { limit: value }, + '#withMaxDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMaxDuration(value): { maxDuration: value }, + '#withMinDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMinDuration(value): { minDuration: value }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TraceQL query or trace ID' } }, + withQuery(value): { query: value }, + '#withSearch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true' } }, + withSearch(value): { search: value }, + '#withServiceMapIncludeNamespace': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Use service.namespace in addition to service.name to uniquely identify a service.' } }, + withServiceMapIncludeNamespace(value=true): { serviceMapIncludeNamespace: value }, + '#withServiceMapQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}' } }, + withServiceMapQuery(value): { serviceMapQuery: value }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by service name' } }, + withServiceName(value): { serviceName: value }, + '#withSpanName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by span name' } }, + withSpanName(value): { spanName: value }, + '#withSpss': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of spans per spanset that are returned from Tempo' } }, + withSpss(value): { spss: value }, + '#withTableType': { 'function': { args: [{ default: null, enums: ['traces', 'spans'], name: 'value', type: ['string'] }], help: 'The type of the table that is used to display the search results' } }, + withTableType(value): { tableType: value }, +} ++ (import '../../custom/query/tempo.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/contactPoint.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/contactPoint.libsonnet new file mode 100644 index 0000000..4b8bbf0 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/contactPoint.libsonnet @@ -0,0 +1,12 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#'+:: { + help+: + ||| + + + **NOTE**: The schemas for all different contact points is under development, this means we can't properly express them in Grafonnet yet. The way this works now may change heavily. + |||, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/muteTiming.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/muteTiming.libsonnet new file mode 100644 index 0000000..4a2efb3 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/muteTiming.libsonnet @@ -0,0 +1,8 @@ +{ + '#withTimeIntervals': { ignore: true }, + '#withIntervals': super['#withTimeIntervals'], + withIntervals: super.withTimeIntervals, + '#withTimeIntervalsMixin': { ignore: true }, + '#withIntervalsMixin': super['#withTimeIntervalsMixin'], + withIntervalsMixin: super.withTimeIntervalsMixin, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/notificationPolicy.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/notificationPolicy.libsonnet new file mode 100644 index 0000000..cf9a2b7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/notificationPolicy.libsonnet @@ -0,0 +1,12 @@ +{ + '#withReceiver': { ignore: true }, + '#withContactPoint': super['#withReceiver'], + withContactPoint: super.withReceiver, + + '#withRoutes': { ignore: true }, + '#withPolicy': super['#withRoutes'], + withPolicy: super.withRoutes, + '#withRoutesMixin': { ignore: true }, + '#withPolicyMixin': super['#withRoutesMixin'], + withPolicyMixin: super.withRoutesMixin, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/ruleGroup.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/ruleGroup.libsonnet new file mode 100644 index 0000000..4ed32af --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/alerting/ruleGroup.libsonnet @@ -0,0 +1,13 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withTitle': { ignore: true }, + '#withName': super['#withTitle'], + withName: super.withTitle, + rule+: { + '#':: d.package.newSub('rule', ''), + '#withTitle': { ignore: true }, + '#withName': super['#withTitle'], + withName: super.withTitle, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard.libsonnet new file mode 100644 index 0000000..0620a22 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard.libsonnet @@ -0,0 +1,44 @@ +local util = import './util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new dashboard with a title.', + args=[d.arg('title', d.T.string)] + ), + new(title): + self.withTitle(title) + + self.withSchemaVersion() + + self.withTimezone('utc') + + self.time.withFrom('now-6h') + + self.time.withTo('now'), + + withPanels(value): { + _panels:: if std.isArray(value) then value else [value], + panels: util.panel.setPanelIDs(self._panels), + }, + withPanelsMixin(value): { + _panels+:: if std.isArray(value) then value else [value], + panels: util.panel.setPanelIDs(self._panels), + }, + + graphTooltip+: { + // 0 - Default + // 1 - Shared crosshair + // 2 - Shared tooltip + '#withSharedCrosshair':: d.func.new( + 'Share crosshair on all panels.', + ), + withSharedCrosshair(): + { graphTooltip: 1 }, + + '#withSharedTooltip':: d.func.new( + 'Share crosshair and tooltip on all panels.', + ), + withSharedTooltip(): + { graphTooltip: 2 }, + }, +} ++ (import './dashboard/annotation.libsonnet') ++ (import './dashboard/link.libsonnet') ++ (import './dashboard/variable.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/annotation.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/annotation.libsonnet new file mode 100644 index 0000000..02892ab --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/annotation.libsonnet @@ -0,0 +1,36 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#annotation':: {}, + + '#withAnnotations': + d.func.new( + ||| + `withAnnotations` adds an array of annotations to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withAnnotations(value): super.annotation.withList(value), + + '#withAnnotationsMixin': + d.func.new( + ||| + `withAnnotationsMixin` adds an array of annotations to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withAnnotationsMixin(value): super.annotation.withListMixin(value), + + annotation: + super.annotation.list + + { + '#':: d.package.newSub( + 'annotation', + '', + ), + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/link.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/link.libsonnet new file mode 100644 index 0000000..eb9b2fe --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/link.libsonnet @@ -0,0 +1,90 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withLinks':: d.func.new( + ||| + Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + + `withLinks` takes an array of [link objects](./link.md). + + The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + + Example: + + ```jsonnet + local g = import 'g.libsonnet'; + local link = g.dashboard.link; + + g.dashboard.new('Title dashboard') + + g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), + ]) + ``` + |||, + [d.arg('value', d.T.array)], + ), + '#withLinksMixin':: self['#withLinks'], + + link+: { + '#':: d.package.newSub( + 'link', + ||| + Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + + The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + + Example: + + ```jsonnet + local g = import 'g.libsonnet'; + local link = g.dashboard.link; + + g.dashboard.new('Title dashboard') + + g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), + ]) + ``` + |||, + ), + + dashboards+: { + '#new':: d.func.new( + ||| + Create links to dashboards based on `tags`. + |||, + args=[ + d.arg('title', d.T.string), + d.arg('tags', d.T.array), + ] + ), + new(title, tags): + self.withTitle(title) + + self.withType('dashboards') + + self.withTags(tags), + + '#withTitle':: {}, + '#withType':: {}, + '#withTags':: {}, + }, + + link+: { + '#new':: d.func.new( + ||| + Create link to an arbitrary URL. + |||, + args=[ + d.arg('title', d.T.string), + d.arg('url', d.T.string), + ] + ), + new(title, url): + self.withTitle(title) + + self.withType('link') + + self.withUrl(url), + + '#withTitle':: {}, + '#withType':: {}, + '#withUrl':: {}, + }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/variable.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/variable.libsonnet new file mode 100644 index 0000000..3cd2988 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/dashboard/variable.libsonnet @@ -0,0 +1,516 @@ +local util = import '../util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local var = super.variable.list, + + '#withVariables': + d.func.new( + ||| + `withVariables` adds an array of variables to a dashboard + |||, + args=[d.arg('value', d.T.array)] + ), + withVariables(value): super.variable.withList(value), + + '#withVariablesMixin': + d.func.new( + ||| + `withVariablesMixin` adds an array of variables to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withVariablesMixin(value): super.variable.withListMixin(value), + + variable: { + '#':: d.package.newSub( + 'variable', + ||| + Example usage: + + ```jsonnet + local g = import 'g.libsonnet'; + local var = g.dashboard.variable; + + local customVar = + var.custom.new( + 'myOptions', + values=['a', 'b', 'c', 'd'], + ) + + var.custom.generalOptions.withDescription( + 'This is a variable for my custom options.' + ) + + var.custom.selectionOptions.withMulti(); + + local queryVar = + var.query.new('queryOptions') + + var.query.queryTypes.withLabelValues( + 'up', + 'instance', + ) + + var.query.withDatasource( + type='prometheus', + uid='mimir-prod', + ) + + var.query.selectionOptions.withIncludeAll(); + + + g.dashboard.new('my dashboard') + + g.dashboard.withVariables([ + customVar, + queryVar, + ]) + ``` + |||, + ), + + local generalOptions = { + generalOptions+: + { + + '#withName': var['#withName'], + withName: var.withName, + '#withLabel': var['#withLabel'], + withLabel: var.withLabel, + '#withDescription': var['#withDescription'], + withDescription: var.withDescription, + + showOnDashboard: { + '#withLabelAndValue':: d.func.new(''), + withLabelAndValue(): var.withHide(0), + '#withValueOnly':: d.func.new(''), + withValueOnly(): var.withHide(1), + '#withNothing':: d.func.new(''), + withNothing(): var.withHide(2), + }, + + '#withCurrent':: d.func.new( + ||| + `withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + |||, + args=[ + d.arg('key', d.T.any), + d.arg('value', d.T.any, default=''), + ] + ), + withCurrent(key, value=key): { + local multi(v) = + if self.multi + && std.isArray(v) + then v + else [v], + current: { + selected: false, + text: multi(key), + value: multi(value), + }, + }, + }, + }, + + local selectionOptions = + { + selectionOptions: + { + '#withMulti':: d.func.new( + 'Enable selecting multiple values.', + args=[ + d.arg('value', d.T.boolean, default=true), + ] + ), + withMulti(value=true): { + multi: value, + }, + + '#withIncludeAll':: d.func.new( + ||| + `withIncludeAll` enables an option to include all variables. + + Optionally you can set a `customAllValue`. + |||, + args=[ + d.arg('value', d.T.boolean, default=true), + d.arg('customAllValue', d.T.boolean, default=null), + ] + ), + withIncludeAll(value=true, customAllValue=null): { + includeAll: value, + [if customAllValue != null then 'allValue']: customAllValue, + }, + }, + }, + + query: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + ||| + Create a query template variable. + + `query` argument is optional, this can also be set with `query.queryTypes`. + |||, + args=[ + d.arg('name', d.T.string), + d.arg('query', d.T.string, default=''), + ] + ), + new(name, query=''): + var.withName(name) + + var.withType('query') + + var.withQuery(query), + + '#withDatasource':: d.func.new( + 'Select a datasource for the variable template query.', + args=[ + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + withDatasource(type, uid): + var.datasource.withType(type) + + var.datasource.withUid(uid), + + '#withDatasourceFromVariable':: d.func.new( + 'Select the datasource from another template variable.', + args=[ + d.arg('variable', d.T.object), + ] + ), + withDatasourceFromVariable(variable): + if variable.type == 'datasource' + then self.withDatasource(variable.query, '${%s}' % variable.name) + else error "`variable` not of type 'datasource'", + + '#withRegex':: d.func.new( + ||| + `withRegex` can extract part of a series name or metric node segment. Named + capture groups can be used to separate the display text and value + ([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). + |||, + args=[ + d.arg('value', d.T.string), + ] + ), + withRegex(value): { + regex: value, + }, + + '#withSort':: d.func.new( + ||| + Choose how to sort the values in the dropdown. + + This can be called as `withSort() to use the integer values for each + option. If `i==0` then it will be ignored and the other arguments will take + precedence. + + The numerical values are: + + - 1 - Alphabetical (asc) + - 2 - Alphabetical (desc) + - 3 - Numerical (asc) + - 4 - Numerical (desc) + - 5 - Alphabetical (case-insensitive, asc) + - 6 - Alphabetical (case-insensitive, desc) + |||, + args=[ + d.arg('i', d.T.number, default=0), + d.arg('type', d.T.string, default='alphabetical'), + d.arg('asc', d.T.boolean, default=true), + d.arg('caseInsensitive', d.T.boolean, default=false), + ], + ), + withSort(i=0, type='alphabetical', asc=true, caseInsensitive=false): + if i != 0 // provide fallback to numerical value + then { sort: i } + else + { + local mapping = { + alphabetical: + if !caseInsensitive + then + if asc + then 1 + else 2 + else + if asc + then 5 + else 6, + numerical: + if asc + then 3 + else 4, + }, + sort: mapping[type], + }, + + // TODO: Expand with Query types to match GUI + queryTypes: { + '#withLabelValues':: d.func.new( + 'Construct a Prometheus template variable using `label_values()`.', + args=[ + d.arg('label', d.T.string), + d.arg('metric', d.T.string, default=''), + ] + ), + withLabelValues(label, metric=''): + if metric == '' + then var.withQuery('label_values(%s)' % label) + else var.withQuery('label_values(%s, %s)' % [metric, label]), + }, + + // Deliberately undocumented, use `refresh` below + withRefresh(value): { + // 1 - On dashboard load + // 2 - On time range chagne + refresh: value, + }, + + local withRefresh = self.withRefresh, + refresh+: { + '#onLoad':: d.func.new( + 'Refresh label values on dashboard load.' + ), + onLoad(): withRefresh(1), + + '#onTime':: d.func.new( + 'Refresh label values on time range change.' + ), + onTime(): withRefresh(2), + }, + }, + + custom: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + ||| + `new` creates a custom template variable. + + The `values` array accepts an object with key/value keys, if it's not an object + then it will be added as a string. + + Example: + ``` + [ + { key: 'mykey', value: 'myvalue' }, + 'myvalue', + 12, + ] + |||, + args=[ + d.arg('name', d.T.string), + d.arg('values', d.T.array), + ] + ), + new(name, values): + var.withName(name) + + var.withType('custom') + + { + // Make values array available in jsonnet + values:: [ + if !std.isObject(item) + then { + key: std.toString(item), + value: std.toString(item), + } + else item + for item in values + ], + + // Render query from values array + query: + std.join(',', [ + std.join(' : ', [item.key, item.value]) + for item in self.values + ]), + + // Set current/options + current: + util.dashboard.getCurrentFromValues( + self.values, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.values), + }, + + withQuery(query): { + values:: util.dashboard.parseCustomQuery(query), + query: query, + }, + }, + + textbox: + generalOptions + + { + '#new':: d.func.new( + '`new` creates a textbox template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('default', d.T.string, default=''), + ] + ), + new(name, default=''): + var.withName(name) + + var.withType('textbox') + + { + local this = self, + default:: default, + query: self.default, + + // Set current/options + keyvaluedict:: [{ key: this.query, value: this.query }], + current: + util.dashboard.getCurrentFromValues( + self.keyvaluedict, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.keyvaluedict), + }, + }, + + constant: + generalOptions + + { + '#new':: d.func.new( + '`new` creates a hidden constant template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('value', d.T.string), + ] + ), + new(name, value=''): + var.withName(name) + + var.withType('constant') + + var.withHide(2) + + var.withQuery(value), + }, + + datasource: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + '`new` creates a datasource template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + ] + ), + new(name, type): + var.withName(name) + + var.withType('datasource') + + var.withQuery(type), + + '#withRegex':: d.func.new( + ||| + `withRegex` filter for which data source instances to choose from in the + variable value list. Example: `/^prod/` + |||, + args=[ + d.arg('value', d.T.string), + ] + ), + withRegex(value): { + regex: value, + }, + }, + + interval: + generalOptions + + { + '#new':: d.func.new( + '`new` creates an interval template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('values', d.T.array), + ] + ), + new(name, values): + var.withName(name) + + var.withType('interval') + + { + // Make values array available in jsonnet + values:: values, + // Render query from values array + query: std.join(',', self.values), + + // Set current/options + keyvaluedict:: [ + { + key: item, + value: item, + } + for item in values + ], + current: + util.dashboard.getCurrentFromValues( + self.keyvaluedict, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.keyvaluedict), + }, + + + '#withAutoOption':: d.func.new( + ||| + `withAutoOption` adds an options to dynamically calculate interval by dividing + time range by the count specified. + + `minInterval' has to be either unit-less or end with one of the following units: + "y, M, w, d, h, m, s, ms". + |||, + args=[ + d.arg('count', d.T.number), + d.arg('minInterval', d.T.string), + ] + ), + withAutoOption(count=30, minInterval='10s'): { + local this = self, + + auto: true, + auto_count: count, + auto_min: minInterval, + + // Add auto item to current/options + keyvaluedict:: + [{ key: 'auto', value: '$__auto_interval_' + this.name }] + + super.keyvaluedict, + }, + }, + + adhoc: + generalOptions + + { + '#new':: d.func.new( + '`new` creates an adhoc template variable for datasource with `type` and `uid`.', + args=[ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + new(name, type, uid): + var.withName(name) + + var.withType('adhoc') + + var.datasource.withType(type) + + var.datasource.withUid(uid), + + '#newFromDatasourceVariable':: d.func.new( + 'Same as `new` but selecting the datasource from another template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('variable', d.T.object), + ] + ), + newFromDatasourceVariable(name, variable): + if variable.type == 'datasource' + then self.new(name, variable.query, '${%s}' % variable.name) + else error "`variable` not of type 'datasource'", + + }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/panel.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/panel.libsonnet new file mode 100644 index 0000000..240a044 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/panel.libsonnet @@ -0,0 +1,171 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +// match name/title to reduce diff in docs +local panelNames = { + alertgroups: 'alertGroups', + annolist: 'annotationsList', + barchart: 'barChart', + bargauge: 'barGauge', + dashlist: 'dashboardList', + nodeGraph: 'nodeGraph', + piechart: 'pieChart', + 'state-timeline': 'stateTimeline', + 'status-history': 'statusHistory', + timeseries: 'timeSeries', + xychart: 'xyChart', +}; + +local getPanelName(type) = + std.get(panelNames, type, type); + +{ + '#new':: d.func.new( + 'Creates a new %s panel with a title.' % getPanelName(self.panelOptions.withType().type), + args=[d.arg('title', d.T.string)] + ), + new(title): + self.panelOptions.withTitle(title) + + self.panelOptions.withType() + + self.panelOptions.withPluginVersion() + // Default to Mixed datasource so panels can be datasource agnostic, this + // requires query targets to explicitly set datasource, which is a lot more + // interesting from a reusability standpoint. + + self.queryOptions.withDatasource('datasource', '-- Mixed --'), + + // Backwards compatible entries, ignored in docs + link+: self.panelOptions.link + { '#':: { ignore: true } }, + thresholdStep+: self.standardOptions.threshold.step + { '#':: { ignore: true } }, + transformation+: self.queryOptions.transformation + { '#':: { ignore: true } }, + valueMapping+: self.standardOptions.mapping + { '#':: { ignore: true } }, + fieldOverride+: self.standardOptions.override + { '#':: { ignore: true } }, + + '#gridPos': {}, // use withGridPos instead, a bit more concise. + local gridPos = self.gridPos, + panelOptions+: { + '#withPluginVersion': {}, + + '#withGridPos': d.func.new( + ||| + `withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + + All arguments default to `null`, which means they will remain unchanged or unset. + |||, + args=[ + d.arg('h', d.T.number, default='null'), + d.arg('w', d.T.number, default='null'), + d.arg('x', d.T.number, default='null'), + d.arg('y', d.T.number, default='null'), + ] + ), + withGridPos(h=null, w=null, x=null, y=null): + (if h != null then gridPos.withH(h) else {}) + + (if w != null then gridPos.withW(w) else {}) + + (if x != null then gridPos.withX(x) else {}) + + (if y != null then gridPos.withY(y) else {}), + }, + + '#datasource':: {}, // use withDatasource instead, bit more concise + local datasource = self.datasource, + queryOptions+: { + '#withDatasource':: d.func.new( + ||| + `withDatasource` sets the datasource for all queries in a panel. + + The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + |||, + args=[ + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + withDatasource(type, uid): + datasource.withType(type) + + datasource.withUid(uid), + }, + + standardOptions+: { + threshold+: { step+: { '#':: d.package.newSub('threshold.step', '') } }, + + local overrides = super.override, + local commonOverrideFunctions = { + '#new':: d.fn( + '`new` creates a new override of type `%s`.' % self.type, + args=[ + d.arg('value', d.T.string), + ] + ), + new(value): + overrides.matcher.withId(self.type) + + overrides.matcher.withOptions(value), + + '#withProperty':: d.fn( + ||| + `withProperty` adds a property that needs to be overridden. This function can + be called multiple time, adding more properties. + |||, + args=[ + d.arg('id', d.T.string), + d.arg('value', d.T.any), + ] + ), + withProperty(id, value): + overrides.withPropertiesMixin([ + overrides.properties.withId(id) + + overrides.properties.withValue(value), + ]), + + '#withPropertiesFromOptions':: d.fn( + ||| + `withPropertiesFromOptions` takes an object with properties that need to be + overridden. See example code above. + |||, + args=[ + d.arg('options', d.T.object), + ] + ), + withPropertiesFromOptions(options): + local infunc(input, path=[]) = + std.foldl( + function(acc, p) + acc + ( + if p == 'custom' + then infunc(input[p], path=path + [p]) + else + overrides.withPropertiesMixin([ + overrides.properties.withId(std.join('.', path + [p])) + + overrides.properties.withValue(input[p]), + ]) + ), + std.objectFields(input), + {} + ); + infunc(options.fieldConfig.defaults), + }, + + override: + { + '#':: d.package.newSub( + 'override', + ||| + Overrides allow you to customize visualization settings for specific fields or + series. This is accomplished by adding an override rule that targets + a particular set of fields and that can each define multiple options. + + ```jsonnet + override.byType.new('number') + + override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') + ) + ``` + ||| + ), + byName: commonOverrideFunctions + { type:: 'byName' }, + byRegexp: commonOverrideFunctions + { type:: 'byRegexp' }, + byType: commonOverrideFunctions + { type:: 'byType' }, + byQuery: commonOverrideFunctions + { type:: 'byFrameRefID' }, + // TODO: byValue takes more complex `options` than string + byValue: commonOverrideFunctions + { type:: 'byValue' }, + }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/loki.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/loki.libsonnet new file mode 100644 index 0000000..9c19f83 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/loki.libsonnet @@ -0,0 +1,27 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new loki query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('expr', d.T.string), + ] + ), + new(datasource, expr): + self.withDatasource(datasource) + + self.withExpr(expr), + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'loki', + uid: value, + }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/prometheus.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/prometheus.libsonnet new file mode 100644 index 0000000..3abe221 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/prometheus.libsonnet @@ -0,0 +1,47 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new prometheus query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('expr', d.T.string), + ] + ), + new(datasource, expr): + self.withDatasource(datasource) + + self.withExpr(expr), + + '#withIntervalFactor':: d.func.new( + 'Set the interval factor for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withIntervalFactor(value): { + intervalFactor: value, + }, + + '#withLegendFormat':: d.func.new( + 'Set the legend format for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withLegendFormat(value): { + legendFormat: value, + }, + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'prometheus', + uid: value, + }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/tempo.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/tempo.libsonnet new file mode 100644 index 0000000..debcb73 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/query/tempo.libsonnet @@ -0,0 +1,29 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new tempo query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('query', d.T.string), + d.arg('filters', d.T.array), + ] + ), + new(datasource, query, filters): + self.withDatasource(datasource) + + self.withQuery(query) + + self.withFilters(filters), + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'tempo', + uid: value, + }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/row.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/row.libsonnet new file mode 100644 index 0000000..049537e --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/row.libsonnet @@ -0,0 +1,26 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new row panel with a title.', + args=[d.arg('title', d.T.string)] + ), + new(title): + self.withTitle(title) + + self.withType() + + self.withCollapsed(false) + + self.gridPos.withX(0) + + self.gridPos.withH(1) + + self.gridPos.withW(24), + + '#gridPos':: {}, // use withGridPos instead + '#withGridPos':: d.func.new( + '`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values.', + args=[d.arg('y', d.T.number)] + ), + withGridPos(y): + self.gridPos.withX(0) + + self.gridPos.withY(y) + + self.gridPos.withH(1) + + self.gridPos.withW(24), +} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/dashboard.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/dashboard.libsonnet similarity index 77% rename from vendor/github.com/grafana/grafonnet/grafonnet-base/util/dashboard.libsonnet rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/dashboard.libsonnet index 17f7c85..da7b2c8 100644 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/dashboard.libsonnet +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/dashboard.libsonnet @@ -11,22 +11,21 @@ local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; get populated by Grafana when importing a dashboard from JSON. This is a bit of a hack and should always be called on functions that set `type` on - a template variable (see the dashboard.templating.list veneer). Ideally Grafana - populates these fields from the `query` value but this provides a backwards - compatible solution. + a template variable. Ideally Grafana populates these fields from the `query` value + but this provides a backwards compatible solution. |||, args=[d.arg('query', d.T.string)], ), - getOptionsForCustomQuery(query): { + getOptionsForCustomQuery(query, multi): { local values = root.parseCustomQuery(query), - current: root.getCurrentFromValues(values), + current: root.getCurrentFromValues(values, multi), options: root.getOptionsFromValues(values), }, - getCurrentFromValues(values): { + getCurrentFromValues(values, multi): { selected: false, - text: values[0].key, - value: values[0].value, + text: if multi then [values[0].key] else values[0].key, + value: if multi then [values[0].value] else values[0].value, }, getOptionsFromValues(values): diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/grid.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/grid.libsonnet new file mode 100644 index 0000000..90a7ec8 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/grid.libsonnet @@ -0,0 +1,173 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +local panelUtil = import './panel.libsonnet'; + +{ + local root = self, + + local gridWidth = 24, + + '#makeGrid':: d.func.new( + ||| + `makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` + and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, + then all panels below it will be folded into the row. + + This function will use the full grid of 24 columns, setting `panelWidth` to a value + that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) + Other value for `panelWidth` will leave a gap on the far right. + + Optional `startY` can be provided to place generated grid above or below existing panels. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('panelWidth', d.T.number), + d.arg('panelHeight', d.T.number), + d.arg('startY', d.T.number), + ], + ), + makeGrid(panels, panelWidth=8, panelHeight=8, startY=0): + local sanitizePanels(ps) = std.map( + function(p) + local sanePanel = panelUtil.sanitizePanel(p); + ( + if p.type == 'row' + then sanePanel + { + panels: sanitizePanels(sanePanel.panels), + } + else sanePanel + { + gridPos+: { + h: panelHeight, + w: panelWidth, + }, + } + ), + ps + ); + + local sanitizedPanels = sanitizePanels(panels); + + local grouped = panelUtil.groupPanelsInRows(sanitizedPanels); + + local panelsBeforeRows = panelUtil.getPanelsBeforeNextRow(grouped); + local rowPanels = + std.filter( + function(p) p.type == 'row', + grouped + ); + + local CalculateXforPanel(index, panel) = + local panelsPerRow = std.floor(gridWidth / panelWidth); + local col = std.mod(index, panelsPerRow); + panel + { gridPos+: { x: panelWidth * col } }; + + local panelsBeforeRowsWithX = std.mapWithIndex(CalculateXforPanel, panelsBeforeRows); + + local rowPanelsWithX = + std.map( + function(row) + row + { panels: std.mapWithIndex(CalculateXforPanel, row.panels) }, + rowPanels + ); + + local uncollapsed = panelUtil.resolveCollapsedFlagOnRows(panelsBeforeRowsWithX + rowPanelsWithX); + + local normalized = panelUtil.normalizeY(uncollapsed); + + std.map(function(p) p + { gridPos+: { y+: startY } }, normalized), + + '#wrapPanels':: d.func.new( + ||| + `wrapPanels` returns an array of `panels` organized in a grid, wrapping up to next 'row' if total width exceeds full grid of 24 columns. + 'panelHeight' and 'panelWidth' are used unless panels already have height and width defined. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('panelWidth', d.T.number), + d.arg('panelHeight', d.T.number), + d.arg('startY', d.T.number), + ], + ), + wrapPanels(panels, panelWidth=8, panelHeight=8, startY=0): + std.foldl( + function(acc, panel) + if panel.type == 'row' + then + // when type=row, start new row immediatly and shift Y of new row by max height recorded + acc + { + panels+: [ + panel + { + gridPos+: + { + x: acc.cursor.x, + y: acc.cursor.y + acc.cursor.maxH, + w: 0, + h: 1, + }, + }, + ], + cursor:: { + x: 0, + y: acc.cursor.y + acc.cursor.maxH + 1, + maxH: 0, + }, + } + else + // handle regular panel + local gridPos = std.get(panel, 'gridPos', {}); + local width = std.get(gridPos, 'w', panelWidth); + local height = std.get(gridPos, 'h', panelHeight); + if acc.cursor.x + width > gridWidth + then + // start new row as width exceeds gridWidth + acc + { + panels+: [ + panel + { + gridPos+: + { + x: 0, + y: acc.cursor.y + height, + w: width, + h: height, + }, + }, + ], + cursor+:: { + x: 0 + width, + y: acc.cursor.y + height, + maxH: if height > super.maxH then height else super.maxH, + }, + } + else + // enough width, place panel on current row + acc + { + panels+: [ + panel + { + gridPos+: + { + x: acc.cursor.x, + y: acc.cursor.y, + w: width, + h: height, + }, + }, + ], + cursor+:: { + x: acc.cursor.x + width, + y: acc.cursor.y, + maxH: if height > super.maxH then height else super.maxH, + }, + }, + panels, + // Initial value for acc + { + panels: [], + cursor:: { + x: 0, + y: startY, + maxH: 0, // max height of current 'row' + }, + } + ).panels, +} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/main.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/main.libsonnet similarity index 100% rename from vendor/github.com/grafana/grafonnet/grafonnet-base/util/main.libsonnet rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/main.libsonnet diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/panel.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/panel.libsonnet new file mode 100644 index 0000000..e2684df --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/panel.libsonnet @@ -0,0 +1,284 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + local this = self, + + '#setPanelIDs':: d.func.new( + ||| + `setPanelIDs` ensures that all `panels` have a unique ID, this functions is used in + `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent + experience. + + used in ../dashboard.libsonnet + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + setPanelIDs(panels): + local infunc(panels, start=1) = + std.foldl( + function(acc, panel) + acc + { + index: // Track the index to ensure no duplicates exist. + acc.index + + 1 + + (if panel.type == 'row' + && 'panels' in panel + then std.length(panel.panels) + else 0), + + panels+: [ + panel + + { id: acc.index } + + ( + if panel.type == 'row' + && 'panels' in panel + then { + panels: + infunc( + panel.panels, + acc.index + 1 + ), + } + else {} + ), + ], + }, + panels, + { index: start, panels: [] } + ).panels; + infunc(panels), + + '#sanitizePanel':: d.func.new( + ||| + `sanitizePanel` ensures the panel has a valid `gridPos` and row panels have `collapsed` and `panels`. This function is recursively applied to panels inside row panels. + + The default values for x,y,h,w are only applied if not already set. + |||, + [ + d.arg('panel', d.T.object), + d.arg('defaultX', d.T.number, default=0), + d.arg('defaultY', d.T.number, default=0), + d.arg('defaultHeight', d.T.number, default=8), + d.arg('defaultWidth', d.T.number, default=8), + ] + ), + sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8): + local infunc(panel) = + panel + + ( + local gridPos = std.get(panel, 'gridPos', {}); + if panel.type == 'row' + then { + collapsed: std.get(panel, 'collapsed', false), + panels: std.map(infunc, std.get(panel, 'panels', [])), + gridPos: { // x, h, w are fixed + x: 0, + y: std.get(gridPos, 'y', defaultY), + h: 1, + w: 24, + }, + } + else { + gridPos: { + x: std.get(gridPos, 'x', defaultX), + y: std.get(gridPos, 'y', defaultY), + h: std.get(gridPos, 'h', defaultHeight), + w: std.get(gridPos, 'w', defaultWidth), + }, + } + ); + infunc(panel), + + '#sortPanelsByXY':: d.func.new( + ||| + `sortPanelsByXY` applies a simple sorting algorithm, first by x then again by y. This does not take width and height into account. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + sortPanelsByXY(panels): + std.sort( + std.sort( + panels, + function(panel) + panel.gridPos.x + ), + function(panel) + panel.gridPos.y + ), + + '#sortPanelsInRow':: d.func.new( + ||| + `sortPanelsInRow` applies `sortPanelsByXY` on the panels in a rowPanel. + |||, + [ + d.arg('rowPanel', d.T.object), + ] + ), + sortPanelsInRow(rowPanel): + rowPanel + { panels: this.sortPanelsByXY(rowPanel.panels) }, + + '#groupPanelsInRows':: d.func.new( + ||| + `groupPanelsInRows` ensures that panels that come after a row panel in an array are added to the `row.panels` attribute. This can be useful to apply intermediate functions to only the panels that belong to a row. Finally the panel array should get processed by `resolveCollapsedFlagOnRows` to "unfold" the rows that are not collapsed into the main array. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + groupPanelsInRows(panels): + // Add panels that come after a row to row.panels + local grouped = + xtd.array.filterMapWithIndex( + function(i, p) p.type == 'row', + function(i, p) + p + { + panels+: + this.getPanelsBeforeNextRow(panels[i + 1:]), + }, + panels, + ); + + // Get panels that come before the rowGroups + local panelsBeforeRowGroups = this.getPanelsBeforeNextRow(panels); + + panelsBeforeRowGroups + grouped, + + '#getPanelsBeforeNextRow':: d.func.new( + ||| + `getPanelsBeforeNextRow` returns all panels in an array up until a row has been found. Used in `groupPanelsInRows`. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + getPanelsBeforeNextRow(panels): + local rowIndexes = + xtd.array.filterMapWithIndex( + function(i, p) p.type == 'row', + function(i, p) i, + panels, + ); + if std.length(rowIndexes) != 0 + then panels[0:rowIndexes[0]] + else panels[0:], // if no row panels found, return all remaining panels + + '#resolveCollapsedFlagOnRows':: d.func.new( + ||| + `resolveCollapsedFlagOnRows` should be applied to the final panel array to "unfold" the rows that are not collapsed into the main array. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + resolveCollapsedFlagOnRows(panels): + std.foldl( + function(acc, panel) + acc + ( + if panel.type == 'row' + && !panel.collapsed + then // If not collapsed, then move panels to main array below the row panel + [panel + { panels: [] }] + + panel.panels + else [panel] + ), + panels, + [], + ), + + '#normalizeY':: d.func.new( + ||| + `normalizeY` applies negative gravity on the inverted Y axis. This mimics the behavior of Grafana: when a panel is created without panel above it, then it'll float upward. + + This is strictly not required as Grafana will do this on dashboard load, however it might be helpful when used when calculating the correct `gridPos`. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + normalizeY(panels): + std.foldl( + function(acc, i) + acc + [ + panels[i] + { + gridPos+: { + y: this.calculateLowestYforPanel(panels[i], acc), + }, + }, + ], + std.range(0, std.length(panels) - 1), + [] + ), + + '#calculateLowestYforPanel':: d.func.new( + ||| + `calculateLowestYforPanel` calculates Y for a given `panel` from the `gridPos` of an array of `panels`. This function is used in `normalizeY`. + |||, + [ + d.arg('panel', d.T.object), + d.arg('panels', d.T.array), + ] + ), + calculateLowestYforPanel(panel, panels): + xtd.number.maxInArray( // the new position is highest value (max) on the Y-scale + std.filterMap( + function(p) // find panels that overlap on X-scale + local v1 = panel.gridPos.x; + local v2 = panel.gridPos.x + panel.gridPos.w; + local x1 = p.gridPos.x; + local x2 = p.gridPos.x + p.gridPos.w; + (v1 >= x1 && v1 < x2) + || (v2 >= x1 && v2 < x2), + function(p) // return new position on Y-scale + p.gridPos.y + p.gridPos.h, + panels, + ), + ), + + '#normalizeYInRow':: d.func.new( + ||| + `normalizeYInRow` applies `normalizeY` to the panels in a row panel. + |||, + [ + d.arg('rowPanel', d.T.object), + ] + ), + normalizeYInRow(rowPanel): + rowPanel + { + panels: + std.map( + function(p) + p + { + gridPos+: { + y: // Increase panel Y with the row Y to put them below the row when not collapsed. + p.gridPos.y + + rowPanel.gridPos.y + + rowPanel.gridPos.h, + }, + }, + this.normalizeY(rowPanel.panels) + ), + }, + + '#mapToRows':: d.func.new( + ||| + `mapToRows` is a little helper function that applies `func` to all row panels in an array. Other panels in that array are returned ad verbatim. + |||, + [ + d.arg('func', d.T.func), + d.arg('panels', d.T.array), + ] + ), + mapToRows(func, panels): + std.map( + function(p) + if p.type == 'row' + then func(p) + else p, + panels + ), +} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/string.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/string.libsonnet similarity index 100% rename from vendor/github.com/grafana/grafonnet/grafonnet-base/util/string.libsonnet rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/custom/util/string.libsonnet diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/README.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/README.md new file mode 100644 index 0000000..b804b46 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/README.md @@ -0,0 +1,31 @@ +# grafonnet + +Jsonnet library for rendering Grafana resources +## Install + +``` +jb install github.com/grafana/grafonnet/gen/grafonnet-v10.2.0@main +``` + +## Usage + +```jsonnet +local grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/main.libsonnet" +``` + + +## Subpackages + +* [accesspolicy](accesspolicy/index.md) +* [alerting](alerting/index.md) +* [dashboard](dashboard/index.md) +* [folder](folder.md) +* [librarypanel](librarypanel.md) +* [panel](panel/index.md) +* [preferences](preferences.md) +* [publicdashboard](publicdashboard.md) +* [query](query/index.md) +* [role](role.md) +* [rolebinding](rolebinding.md) +* [team](team.md) +* [util](util.md) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/accesspolicy/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/accesspolicy/index.md new file mode 100644 index 0000000..ff3dcfc --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/accesspolicy/index.md @@ -0,0 +1,156 @@ +# accesspolicy + +grafonnet.accesspolicy + +## Subpackages + +* [rules](rules.md) + +## Index + +* [`fn withRole(value)`](#fn-withrole) +* [`fn withRoleMixin(value)`](#fn-withrolemixin) +* [`fn withRules(value)`](#fn-withrules) +* [`fn withRulesMixin(value)`](#fn-withrulesmixin) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withScopeMixin(value)`](#fn-withscopemixin) +* [`obj role`](#obj-role) + * [`fn withKind(value)`](#fn-rolewithkind) + * [`fn withName(value)`](#fn-rolewithname) + * [`fn withXname(value)`](#fn-rolewithxname) +* [`obj scope`](#obj-scope) + * [`fn withKind(value)`](#fn-scopewithkind) + * [`fn withName(value)`](#fn-scopewithname) + +## Fields + +### fn withRole + +```jsonnet +withRole(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withRoleMixin + +```jsonnet +withRoleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withRules + +```jsonnet +withRules(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The set of rules to apply. Note that * is required to modify +access policy rules, and that "none" will reject all actions +### fn withRulesMixin + +```jsonnet +withRulesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The set of rules to apply. Note that * is required to modify +access policy rules, and that "none" will reject all actions +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScopeMixin + +```jsonnet +withScopeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj role + + +#### fn role.withKind + +```jsonnet +role.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Role"`, `"BuiltinRole"`, `"Team"`, `"User"` + +Policies can apply to roles, teams, or users +Applying policies to individual users is supported, but discouraged +#### fn role.withName + +```jsonnet +role.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn role.withXname + +```jsonnet +role.withXname(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj scope + + +#### fn scope.withKind + +```jsonnet +scope.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn scope.withName + +```jsonnet +scope.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/accesspolicy/rules.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/accesspolicy/rules.md new file mode 100644 index 0000000..6f328d4 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/accesspolicy/rules.md @@ -0,0 +1,46 @@ +# rules + + + +## Index + +* [`fn withKind(value)`](#fn-withkind) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withVerb(value)`](#fn-withverb) + +## Fields + +### fn withKind + +```jsonnet +withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The kind this rule applies to (dashboards, alert, etc) +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific sub-elements like "alert.rules" or "dashboard.permissions"???? +### fn withVerb + +```jsonnet +withVerb(value) +``` + +PARAMETERS: + +* **value** (`string`) + +READ, WRITE, CREATE, DELETE, ... +should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/contactPoint.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/contactPoint.md new file mode 100644 index 0000000..b796b0c --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/contactPoint.md @@ -0,0 +1,100 @@ +# contactPoint + +grafonnet.alerting.contactPoint + +**NOTE**: The schemas for all different contact points is under development, this means we can't properly express them in Grafonnet yet. The way this works now may change heavily. + + +## Index + +* [`fn withDisableResolveMessage(value=true)`](#fn-withdisableresolvemessage) +* [`fn withName(value)`](#fn-withname) +* [`fn withProvenance(value)`](#fn-withprovenance) +* [`fn withSettings(value)`](#fn-withsettings) +* [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withDisableResolveMessage + +```jsonnet +withDisableResolveMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name is used as grouping key in the UI. Contact points with the +same name will be grouped in the UI. +### fn withProvenance + +```jsonnet +withProvenance(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withSettings + +```jsonnet +withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSettingsMixin + +```jsonnet +withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"` + + +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +UID is the unique identifier of the contact point. The UID can be +set by the user. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/index.md new file mode 100644 index 0000000..b77a82d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/index.md @@ -0,0 +1,11 @@ +# alerting + +grafonnet.alerting + +## Subpackages + +* [contactPoint](contactPoint.md) +* [messageTemplate](messageTemplate.md) +* [muteTiming](muteTiming/index.md) +* [notificationPolicy](notificationPolicy/index.md) +* [ruleGroup](ruleGroup/index.md) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/messageTemplate.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/messageTemplate.md new file mode 100644 index 0000000..df7c233 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/messageTemplate.md @@ -0,0 +1,32 @@ +# messageTemplate + +grafonnet.alerting.messageTemplate + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withTemplate(value)`](#fn-withtemplate) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTemplate + +```jsonnet +withTemplate(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/index.md new file mode 100644 index 0000000..3aee846 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/index.md @@ -0,0 +1,48 @@ +# muteTiming + +grafonnet.alerting.muteTiming + +## Subpackages + +* [interval](interval/index.md) + +## Index + +* [`fn withIntervals(value)`](#fn-withintervals) +* [`fn withIntervalsMixin(value)`](#fn-withintervalsmixin) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withIntervals + +```jsonnet +withIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withIntervalsMixin + +```jsonnet +withIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/interval/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/interval/index.md new file mode 100644 index 0000000..aecdd1d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/interval/index.md @@ -0,0 +1,144 @@ +# interval + + + +## Subpackages + +* [times](times.md) + +## Index + +* [`fn withDaysOfMonth(value)`](#fn-withdaysofmonth) +* [`fn withDaysOfMonthMixin(value)`](#fn-withdaysofmonthmixin) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withMonths(value)`](#fn-withmonths) +* [`fn withMonthsMixin(value)`](#fn-withmonthsmixin) +* [`fn withTimes(value)`](#fn-withtimes) +* [`fn withTimesMixin(value)`](#fn-withtimesmixin) +* [`fn withWeekdays(value)`](#fn-withweekdays) +* [`fn withWeekdaysMixin(value)`](#fn-withweekdaysmixin) +* [`fn withYears(value)`](#fn-withyears) +* [`fn withYearsMixin(value)`](#fn-withyearsmixin) + +## Fields + +### fn withDaysOfMonth + +```jsonnet +withDaysOfMonth(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDaysOfMonthMixin + +```jsonnet +withDaysOfMonthMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMonths + +```jsonnet +withMonths(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMonthsMixin + +```jsonnet +withMonthsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimes + +```jsonnet +withTimes(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimesMixin + +```jsonnet +withTimesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdays + +```jsonnet +withWeekdays(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdaysMixin + +```jsonnet +withWeekdaysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYears + +```jsonnet +withYears(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYearsMixin + +```jsonnet +withYearsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/interval/times.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/interval/times.md new file mode 100644 index 0000000..43f7b3f --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/muteTiming/interval/times.md @@ -0,0 +1,32 @@ +# times + + + +## Index + +* [`fn withFrom(value)`](#fn-withfrom) +* [`fn withTo(value)`](#fn-withto) + +## Fields + +### fn withFrom + +```jsonnet +withFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTo + +```jsonnet +withTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/notificationPolicy/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/notificationPolicy/index.md new file mode 100644 index 0000000..cb4aa0a --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/notificationPolicy/index.md @@ -0,0 +1,173 @@ +# notificationPolicy + +grafonnet.alerting.notificationPolicy + +## Subpackages + +* [matcher](matcher.md) + +## Index + +* [`fn withContactPoint(value)`](#fn-withcontactpoint) +* [`fn withContinue(value=true)`](#fn-withcontinue) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withGroupInterval(value)`](#fn-withgroupinterval) +* [`fn withGroupWait(value)`](#fn-withgroupwait) +* [`fn withMatchers(value)`](#fn-withmatchers) +* [`fn withMatchersMixin(value)`](#fn-withmatchersmixin) +* [`fn withMuteTimeIntervals(value)`](#fn-withmutetimeintervals) +* [`fn withMuteTimeIntervalsMixin(value)`](#fn-withmutetimeintervalsmixin) +* [`fn withPolicy(value)`](#fn-withpolicy) +* [`fn withPolicyMixin(value)`](#fn-withpolicymixin) +* [`fn withRepeatInterval(value)`](#fn-withrepeatinterval) + +## Fields + +### fn withContactPoint + +```jsonnet +withContactPoint(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withContinue + +```jsonnet +withContinue(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupInterval + +```jsonnet +withGroupInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withGroupWait + +```jsonnet +withGroupWait(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMatchers + +```jsonnet +withMatchers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Matchers is a slice of Matchers that is sortable, implements Stringer, and +provides a Matches method to match a LabelSet against all Matchers in the +slice. Note that some users of Matchers might require it to be sorted. +### fn withMatchersMixin + +```jsonnet +withMatchersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Matchers is a slice of Matchers that is sortable, implements Stringer, and +provides a Matches method to match a LabelSet against all Matchers in the +slice. Note that some users of Matchers might require it to be sorted. +### fn withMuteTimeIntervals + +```jsonnet +withMuteTimeIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMuteTimeIntervalsMixin + +```jsonnet +withMuteTimeIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPolicy + +```jsonnet +withPolicy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPolicyMixin + +```jsonnet +withPolicyMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRepeatInterval + +```jsonnet +withRepeatInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/notificationPolicy/matcher.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/notificationPolicy/matcher.md new file mode 100644 index 0000000..f31b1d8 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/notificationPolicy/matcher.md @@ -0,0 +1,45 @@ +# matcher + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType(value)`](#fn-withtype) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"="`, `"!="`, `"=~"`, `"!~"` + +MatchType is an enum for label matching types. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/index.md new file mode 100644 index 0000000..21d94b5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/index.md @@ -0,0 +1,72 @@ +# ruleGroup + +grafonnet.alerting.ruleGroup + +## Subpackages + +* [rule](rule/index.md) + +## Index + +* [`fn withFolderUid(value)`](#fn-withfolderuid) +* [`fn withInterval(value)`](#fn-withinterval) +* [`fn withName(value)`](#fn-withname) +* [`fn withRules(value)`](#fn-withrules) +* [`fn withRulesMixin(value)`](#fn-withrulesmixin) + +## Fields + +### fn withFolderUid + +```jsonnet +withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withInterval + +```jsonnet +withInterval(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRules + +```jsonnet +withRules(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRulesMixin + +```jsonnet +withRulesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/rule/data.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/rule/data.md new file mode 100644 index 0000000..0c60520 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/rule/data.md @@ -0,0 +1,128 @@ +# data + + + +## Index + +* [`fn withDatasourceUid(value)`](#fn-withdatasourceuid) +* [`fn withModel(value)`](#fn-withmodel) +* [`fn withModelMixin(value)`](#fn-withmodelmixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withRelativeTimeRange(value)`](#fn-withrelativetimerange) +* [`fn withRelativeTimeRangeMixin(value)`](#fn-withrelativetimerangemixin) +* [`obj relativeTimeRange`](#obj-relativetimerange) + * [`fn withFrom(value)`](#fn-relativetimerangewithfrom) + * [`fn withTo(value)`](#fn-relativetimerangewithto) + +## Fields + +### fn withDatasourceUid + +```jsonnet +withDatasourceUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation. +### fn withModel + +```jsonnet +withModel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +JSON is the raw JSON query and includes the above properties as well as custom properties. +### fn withModelMixin + +```jsonnet +withModelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +JSON is the raw JSON query and includes the above properties as well as custom properties. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withRelativeTimeRange + +```jsonnet +withRelativeTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +RelativeTimeRange is the per query start and end time +for requests. +### fn withRelativeTimeRangeMixin + +```jsonnet +withRelativeTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +RelativeTimeRange is the per query start and end time +for requests. +### obj relativeTimeRange + + +#### fn relativeTimeRange.withFrom + +```jsonnet +relativeTimeRange.withFrom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +A Duration represents the elapsed time between two instants +as an int64 nanosecond count. The representation limits the +largest representable duration to approximately 290 years. +#### fn relativeTimeRange.withTo + +```jsonnet +relativeTimeRange.withTo(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +A Duration represents the elapsed time between two instants +as an int64 nanosecond count. The representation limits the +largest representable duration to approximately 290 years. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/rule/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/rule/index.md new file mode 100644 index 0000000..e93787c --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/alerting/ruleGroup/rule/index.md @@ -0,0 +1,161 @@ +# rule + + + +## Subpackages + +* [data](data.md) + +## Index + +* [`fn withAnnotations(value)`](#fn-withannotations) +* [`fn withAnnotationsMixin(value)`](#fn-withannotationsmixin) +* [`fn withCondition(value)`](#fn-withcondition) +* [`fn withData(value)`](#fn-withdata) +* [`fn withDataMixin(value)`](#fn-withdatamixin) +* [`fn withExecErrState(value)`](#fn-withexecerrstate) +* [`fn withFor(value)`](#fn-withfor) +* [`fn withIsPaused(value=true)`](#fn-withispaused) +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withLabelsMixin(value)`](#fn-withlabelsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withNoDataState(value)`](#fn-withnodatastate) + +## Fields + +### fn withAnnotations + +```jsonnet +withAnnotations(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAnnotationsMixin + +```jsonnet +withAnnotationsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withCondition + +```jsonnet +withCondition(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withData + +```jsonnet +withData(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDataMixin + +```jsonnet +withDataMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withExecErrState + +```jsonnet +withExecErrState(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"OK"`, `"Alerting"`, `"Error"` + + +### fn withFor + +```jsonnet +withFor(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +A Duration represents the elapsed time between two instants +as an int64 nanosecond count. The representation limits the +largest representable duration to approximately 290 years. +### fn withIsPaused + +```jsonnet +withIsPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLabelsMixin + +```jsonnet +withLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withNoDataState + +```jsonnet +withNoDataState(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Alerting"`, `"NoData"`, `"OK"` + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/annotation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/annotation.md similarity index 62% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/annotation.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/annotation.md index 4f3b261..7395529 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/annotation.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/annotation.md @@ -4,12 +4,13 @@ ## Index +* [`fn withBuiltIn(value=0)`](#fn-withbuiltin) * [`fn withDatasource(value)`](#fn-withdatasource) * [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withEnable(value=true)`](#fn-withenable) * [`fn withFilter(value)`](#fn-withfilter) * [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withHide(value=false)`](#fn-withhide) +* [`fn withHide(value=true)`](#fn-withhide) * [`fn withIconColor(value)`](#fn-withiconcolor) * [`fn withName(value)`](#fn-withname) * [`fn withTarget(value)`](#fn-withtarget) @@ -19,199 +20,279 @@ * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj filter`](#obj-filter) - * [`fn withExclude(value=false)`](#fn-filterwithexclude) + * [`fn withExclude(value=true)`](#fn-filterwithexclude) * [`fn withIds(value)`](#fn-filterwithids) * [`fn withIdsMixin(value)`](#fn-filterwithidsmixin) * [`obj target`](#obj-target) * [`fn withLimit(value)`](#fn-targetwithlimit) - * [`fn withMatchAny(value)`](#fn-targetwithmatchany) + * [`fn withMatchAny(value=true)`](#fn-targetwithmatchany) * [`fn withTags(value)`](#fn-targetwithtags) * [`fn withTagsMixin(value)`](#fn-targetwithtagsmixin) * [`fn withType(value)`](#fn-targetwithtype) ## Fields +### fn withBuiltIn + +```jsonnet +withBuiltIn(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Set to 1 for the standard annotation query all dashboards have by default. ### fn withDatasource -```ts +```jsonnet withDatasource(value) ``` -TODO: Should be DataSourceRef +PARAMETERS: + +* **value** (`object`) +Ref to a DataSource instance ### fn withDatasourceMixin -```ts +```jsonnet withDatasourceMixin(value) ``` -TODO: Should be DataSourceRef +PARAMETERS: + +* **value** (`object`) +Ref to a DataSource instance ### fn withEnable -```ts +```jsonnet withEnable(value=true) ``` -When enabled the annotation query is issued with every dashboard refresh +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +When enabled the annotation query is issued with every dashboard refresh ### fn withFilter -```ts +```jsonnet withFilter(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withFilterMixin -```ts +```jsonnet withFilterMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withHide -```ts -withHide(value=false) +```jsonnet +withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + Annotation queries can be toggled on or off at the top of the dashboard. When hide is true, the toggle is not shown in the dashboard. - ### fn withIconColor -```ts +```jsonnet withIconColor(value) ``` -Color to use for the annotation event markers +PARAMETERS: +* **value** (`string`) + +Color to use for the annotation event markers ### fn withName -```ts +```jsonnet withName(value) ``` -Name of annotation. +PARAMETERS: + +* **value** (`string`) +Name of annotation. ### fn withTarget -```ts +```jsonnet withTarget(value) ``` +PARAMETERS: + +* **value** (`object`) + TODO: this should be a regular DataQuery that depends on the selected dashboard these match the properties of the "grafana" datasouce that is default in most dashboards - ### fn withTargetMixin -```ts +```jsonnet withTargetMixin(value) ``` +PARAMETERS: + +* **value** (`object`) + TODO: this should be a regular DataQuery that depends on the selected dashboard these match the properties of the "grafana" datasouce that is default in most dashboards - ### fn withType -```ts +```jsonnet withType(value) ``` -TODO -- this should not exist here, it is based on the --grafana-- datasource +PARAMETERS: +* **value** (`string`) + +TODO -- this should not exist here, it is based on the --grafana-- datasource ### obj datasource #### fn datasource.withType -```ts -withType(value) +```jsonnet +datasource.withType(value) ``` +PARAMETERS: +* **value** (`string`) +The plugin type-id #### fn datasource.withUid -```ts -withUid(value) +```jsonnet +datasource.withUid(value) ``` +PARAMETERS: +* **value** (`string`) +Specific datasource instance ### obj filter #### fn filter.withExclude -```ts -withExclude(value=false) +```jsonnet +filter.withExclude(value=true) ``` -Should the specified panels be included or excluded +PARAMETERS: +* **value** (`boolean`) + - default value: `true` + +Should the specified panels be included or excluded #### fn filter.withIds -```ts -withIds(value) +```jsonnet +filter.withIds(value) ``` -Panel IDs that should be included or excluded +PARAMETERS: +* **value** (`array`) + +Panel IDs that should be included or excluded #### fn filter.withIdsMixin -```ts -withIdsMixin(value) +```jsonnet +filter.withIdsMixin(value) ``` -Panel IDs that should be included or excluded +PARAMETERS: + +* **value** (`array`) +Panel IDs that should be included or excluded ### obj target #### fn target.withLimit -```ts -withLimit(value) +```jsonnet +target.withLimit(value) ``` +PARAMETERS: + +* **value** (`integer`) + Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change - #### fn target.withMatchAny -```ts -withMatchAny(value) +```jsonnet +target.withMatchAny(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change - #### fn target.withTags -```ts -withTags(value) +```jsonnet +target.withTags(value) ``` +PARAMETERS: + +* **value** (`array`) + Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change - #### fn target.withTagsMixin -```ts -withTagsMixin(value) +```jsonnet +target.withTagsMixin(value) ``` +PARAMETERS: + +* **value** (`array`) + Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change - #### fn target.withType -```ts -withType(value) +```jsonnet +target.withType(value) ``` +PARAMETERS: + +* **value** (`string`) + Only required/valid for the grafana datasource... -but code+tests is already depending on it so hard to change +but code+tests is already depending on it so hard to change \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/index.md similarity index 53% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/index.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/index.md index e68e1d3..543f843 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/index.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/index.md @@ -18,13 +18,12 @@ grafonnet.dashboard * [`fn withFiscalYearStartMonth(value=0)`](#fn-withfiscalyearstartmonth) * [`fn withLinks(value)`](#fn-withlinks) * [`fn withLinksMixin(value)`](#fn-withlinksmixin) -* [`fn withLiveNow(value)`](#fn-withlivenow) +* [`fn withLiveNow(value=true)`](#fn-withlivenow) * [`fn withPanels(value)`](#fn-withpanels) * [`fn withPanelsMixin(value)`](#fn-withpanelsmixin) * [`fn withRefresh(value)`](#fn-withrefresh) * [`fn withRefreshMixin(value)`](#fn-withrefreshmixin) * [`fn withSchemaVersion(value=36)`](#fn-withschemaversion) -* [`fn withStyle(value="dark")`](#fn-withstyle) * [`fn withTags(value)`](#fn-withtags) * [`fn withTagsMixin(value)`](#fn-withtagsmixin) * [`fn withTemplating(value)`](#fn-withtemplating) @@ -42,9 +41,8 @@ grafonnet.dashboard * [`fn withFrom(value="now-6h")`](#fn-timewithfrom) * [`fn withTo(value="now")`](#fn-timewithto) * [`obj timepicker`](#obj-timepicker) - * [`fn withCollapse(value=false)`](#fn-timepickerwithcollapse) - * [`fn withEnable(value=true)`](#fn-timepickerwithenable) - * [`fn withHidden(value=false)`](#fn-timepickerwithhidden) + * [`fn withCollapse(value=true)`](#fn-timepickerwithcollapse) + * [`fn withHidden(value=true)`](#fn-timepickerwithhidden) * [`fn withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervals) * [`fn withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervalsmixin) * [`fn withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptions) @@ -54,256 +52,364 @@ grafonnet.dashboard ### fn new -```ts +```jsonnet new(title) ``` -Creates a new dashboard with a title. +PARAMETERS: + +* **title** (`string`) +Creates a new dashboard with a title. ### fn withAnnotations -```ts +```jsonnet withAnnotations(value) ``` +PARAMETERS: + +* **value** (`array`) + `withAnnotations` adds an array of annotations to a dashboard. This function appends passed data to existing values - ### fn withAnnotationsMixin -```ts +```jsonnet withAnnotationsMixin(value) ``` +PARAMETERS: + +* **value** (`array`) + `withAnnotationsMixin` adds an array of annotations to a dashboard. This function appends passed data to existing values - ### fn withDescription -```ts +```jsonnet withDescription(value) ``` -Description of dashboard. +PARAMETERS: + +* **value** (`string`) +Description of dashboard. ### fn withEditable -```ts +```jsonnet withEditable(value=true) ``` -Whether a dashboard is editable or not. +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +Whether a dashboard is editable or not. ### fn withFiscalYearStartMonth -```ts +```jsonnet withFiscalYearStartMonth(value=0) ``` -The month that the fiscal year starts on. 0 = January, 11 = December +PARAMETERS: + +* **value** (`integer`) + - default value: `0` +The month that the fiscal year starts on. 0 = January, 11 = December ### fn withLinks -```ts +```jsonnet withLinks(value) ``` -TODO docs +PARAMETERS: + +* **value** (`array`) + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +`withLinks` takes an array of [link objects](./link.md). + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` ### fn withLinksMixin -```ts +```jsonnet withLinksMixin(value) ``` -TODO docs +PARAMETERS: + +* **value** (`array`) + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +`withLinks` takes an array of [link objects](./link.md). + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` ### fn withLiveNow -```ts -withLiveNow(value) +```jsonnet +withLiveNow(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + When set to true, the dashboard will redraw panels at an interval matching the pixel width. -This will keep data "moving left" regardless of the query refresh rate. This setting helps +This will keep data "moving left" regardless of the query refresh rate. This setting helps avoid dashboards presenting stale live data - ### fn withPanels -```ts +```jsonnet withPanels(value) ``` +PARAMETERS: + +* **value** (`array`) ### fn withPanelsMixin -```ts +```jsonnet withPanelsMixin(value) ``` +PARAMETERS: + +* **value** (`array`) ### fn withRefresh -```ts +```jsonnet withRefresh(value) ``` -Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". +PARAMETERS: + +* **value** (`string`) +Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". ### fn withRefreshMixin -```ts +```jsonnet withRefreshMixin(value) ``` -Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". +PARAMETERS: + +* **value** (`string`) +Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". ### fn withSchemaVersion -```ts +```jsonnet withSchemaVersion(value=36) ``` -Version of the JSON schema, incremented each time a Grafana update brings -changes to said schema. -TODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion - -### fn withStyle - -```ts -withStyle(value="dark") -``` - -Theme of dashboard. +PARAMETERS: -Accepted values for `value` are "dark", "light" +* **value** (`integer`) + - default value: `36` +Version of the JSON schema, incremented each time a Grafana update brings +changes to said schema. ### fn withTags -```ts +```jsonnet withTags(value) ``` -Tags associated with dashboard. +PARAMETERS: + +* **value** (`array`) +Tags associated with dashboard. ### fn withTagsMixin -```ts +```jsonnet withTagsMixin(value) ``` -Tags associated with dashboard. +PARAMETERS: + +* **value** (`array`) +Tags associated with dashboard. ### fn withTemplating -```ts +```jsonnet withTemplating(value) ``` -TODO docs +PARAMETERS: + +* **value** (`object`) +Configured template variables ### fn withTemplatingMixin -```ts +```jsonnet withTemplatingMixin(value) ``` -TODO docs +PARAMETERS: + +* **value** (`object`) +Configured template variables ### fn withTimezone -```ts +```jsonnet withTimezone(value="browser") ``` -Timezone of dashboard. Accepts IANA TZDB zone ID or "browser" or "utc". +PARAMETERS: +* **value** (`string`) + - default value: `"browser"` + +Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc". ### fn withTitle -```ts +```jsonnet withTitle(value) ``` -Title of dashboard. +PARAMETERS: + +* **value** (`string`) +Title of dashboard. ### fn withUid -```ts +```jsonnet withUid(value) ``` -Unique dashboard identifier that can be generated by anyone. string (8-40) +PARAMETERS: + +* **value** (`string`) +Unique dashboard identifier that can be generated by anyone. string (8-40) ### fn withVariables -```ts +```jsonnet withVariables(value) ``` -`withVariables` adds an array of variables to a dashboard +PARAMETERS: +* **value** (`array`) + +`withVariables` adds an array of variables to a dashboard ### fn withVariablesMixin -```ts +```jsonnet withVariablesMixin(value) ``` +PARAMETERS: + +* **value** (`array`) + `withVariablesMixin` adds an array of variables to a dashboard. This function appends passed data to existing values - ### fn withWeekStart -```ts +```jsonnet withWeekStart(value) ``` -TODO docs +PARAMETERS: + +* **value** (`string`) +Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday". ### obj graphTooltip #### fn graphTooltip.withSharedCrosshair -```ts -withSharedCrosshair() +```jsonnet +graphTooltip.withSharedCrosshair() ``` -Share crosshair on all panels. +Share crosshair on all panels. #### fn graphTooltip.withSharedTooltip -```ts -withSharedTooltip() +```jsonnet +graphTooltip.withSharedTooltip() ``` -Share crosshair and tooltip on all panels. +Share crosshair and tooltip on all panels. ### obj time #### fn time.withFrom -```ts -withFrom(value="now-6h") +```jsonnet +time.withFrom(value="now-6h") ``` +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` #### fn time.withTo -```ts -withTo(value="now") +```jsonnet +time.withTo(value="now") ``` +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` ### obj timepicker @@ -311,56 +417,73 @@ withTo(value="now") #### fn timepicker.withCollapse -```ts -withCollapse(value=false) +```jsonnet +timepicker.withCollapse(value=true) ``` -Whether timepicker is collapsed or not. +PARAMETERS: -#### fn timepicker.withEnable - -```ts -withEnable(value=true) -``` - -Whether timepicker is enabled or not. +* **value** (`boolean`) + - default value: `true` +Whether timepicker is collapsed or not. Has no effect on provisioned dashboard. #### fn timepicker.withHidden -```ts -withHidden(value=false) +```jsonnet +timepicker.withHidden(value=true) ``` -Whether timepicker is visible or not. +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +Whether timepicker is visible or not. #### fn timepicker.withRefreshIntervals -```ts -withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) +```jsonnet +timepicker.withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) ``` -Selectable intervals for auto-refresh. +PARAMETERS: +* **value** (`array`) + - default value: `["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]` + +Interval options available in the refresh picker dropdown. #### fn timepicker.withRefreshIntervalsMixin -```ts -withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) +```jsonnet +timepicker.withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) ``` -Selectable intervals for auto-refresh. +PARAMETERS: + +* **value** (`array`) + - default value: `["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]` +Interval options available in the refresh picker dropdown. #### fn timepicker.withTimeOptions -```ts -withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) +```jsonnet +timepicker.withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) ``` -TODO docs +PARAMETERS: + +* **value** (`array`) + - default value: `["5m","15m","1h","6h","12h","24h","2d","7d","30d"]` +Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. #### fn timepicker.withTimeOptionsMixin -```ts -withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) +```jsonnet +timepicker.withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) ``` -TODO docs +PARAMETERS: + +* **value** (`array`) + - default value: `["5m","15m","1h","6h","12h","24h","2d","7d","30d"]` + +Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/link.md new file mode 100644 index 0000000..421e0c0 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/link.md @@ -0,0 +1,196 @@ +# link + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + + +## Index + +* [`obj dashboards`](#obj-dashboards) + * [`fn new(title, tags)`](#fn-dashboardsnew) + * [`obj options`](#obj-dashboardsoptions) + * [`fn withAsDropdown(value=true)`](#fn-dashboardsoptionswithasdropdown) + * [`fn withIncludeVars(value=true)`](#fn-dashboardsoptionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-dashboardsoptionswithkeeptime) + * [`fn withTargetBlank(value=true)`](#fn-dashboardsoptionswithtargetblank) +* [`obj link`](#obj-link) + * [`fn new(title, url)`](#fn-linknew) + * [`fn withIcon(value)`](#fn-linkwithicon) + * [`fn withTooltip(value)`](#fn-linkwithtooltip) + * [`obj options`](#obj-linkoptions) + * [`fn withAsDropdown(value=true)`](#fn-linkoptionswithasdropdown) + * [`fn withIncludeVars(value=true)`](#fn-linkoptionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-linkoptionswithkeeptime) + * [`fn withTargetBlank(value=true)`](#fn-linkoptionswithtargetblank) + +## Fields + +### obj dashboards + + +#### fn dashboards.new + +```jsonnet +dashboards.new(title, tags) +``` + +PARAMETERS: + +* **title** (`string`) +* **tags** (`array`) + +Create links to dashboards based on `tags`. + +#### obj dashboards.options + + +##### fn dashboards.options.withAsDropdown + +```jsonnet +dashboards.options.withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +##### fn dashboards.options.withIncludeVars + +```jsonnet +dashboards.options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +##### fn dashboards.options.withKeepTime + +```jsonnet +dashboards.options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +##### fn dashboards.options.withTargetBlank + +```jsonnet +dashboards.options.withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### obj link + + +#### fn link.new + +```jsonnet +link.new(title, url) +``` + +PARAMETERS: + +* **title** (`string`) +* **url** (`string`) + +Create link to an arbitrary URL. + +#### fn link.withIcon + +```jsonnet +link.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +#### fn link.withTooltip + +```jsonnet +link.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +#### obj link.options + + +##### fn link.options.withAsDropdown + +```jsonnet +link.options.withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +##### fn link.options.withIncludeVars + +```jsonnet +link.options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +##### fn link.options.withKeepTime + +```jsonnet +link.options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +##### fn link.options.withTargetBlank + +```jsonnet +link.options.withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/variable.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/variable.md similarity index 57% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/variable.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/variable.md index 8999706..3b8eba5 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/variable.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/dashboard/variable.md @@ -41,8 +41,9 @@ g.dashboard.new('my dashboard') * [`obj adhoc`](#obj-adhoc) * [`fn new(name, type, uid)`](#fn-adhocnew) - * [`fn newFromVariable(name, variable)`](#fn-adhocnewfromvariable) + * [`fn newFromDatasourceVariable(name, variable)`](#fn-adhocnewfromdatasourcevariable) * [`obj generalOptions`](#obj-adhocgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-adhocgeneraloptionswithcurrent) * [`fn withDescription(value)`](#fn-adhocgeneraloptionswithdescription) * [`fn withLabel(value)`](#fn-adhocgeneraloptionswithlabel) * [`fn withName(value)`](#fn-adhocgeneraloptionswithname) @@ -53,6 +54,7 @@ g.dashboard.new('my dashboard') * [`obj constant`](#obj-constant) * [`fn new(name, value)`](#fn-constantnew) * [`obj generalOptions`](#obj-constantgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-constantgeneraloptionswithcurrent) * [`fn withDescription(value)`](#fn-constantgeneraloptionswithdescription) * [`fn withLabel(value)`](#fn-constantgeneraloptionswithlabel) * [`fn withName(value)`](#fn-constantgeneraloptionswithname) @@ -63,6 +65,7 @@ g.dashboard.new('my dashboard') * [`obj custom`](#obj-custom) * [`fn new(name, values)`](#fn-customnew) * [`obj generalOptions`](#obj-customgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-customgeneraloptionswithcurrent) * [`fn withDescription(value)`](#fn-customgeneraloptionswithdescription) * [`fn withLabel(value)`](#fn-customgeneraloptionswithlabel) * [`fn withName(value)`](#fn-customgeneraloptionswithname) @@ -77,6 +80,7 @@ g.dashboard.new('my dashboard') * [`fn new(name, type)`](#fn-datasourcenew) * [`fn withRegex(value)`](#fn-datasourcewithregex) * [`obj generalOptions`](#obj-datasourcegeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-datasourcegeneraloptionswithcurrent) * [`fn withDescription(value)`](#fn-datasourcegeneraloptionswithdescription) * [`fn withLabel(value)`](#fn-datasourcegeneraloptionswithlabel) * [`fn withName(value)`](#fn-datasourcegeneraloptionswithname) @@ -91,6 +95,7 @@ g.dashboard.new('my dashboard') * [`fn new(name, values)`](#fn-intervalnew) * [`fn withAutoOption(count, minInterval)`](#fn-intervalwithautooption) * [`obj generalOptions`](#obj-intervalgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-intervalgeneraloptionswithcurrent) * [`fn withDescription(value)`](#fn-intervalgeneraloptionswithdescription) * [`fn withLabel(value)`](#fn-intervalgeneraloptionswithlabel) * [`fn withName(value)`](#fn-intervalgeneraloptionswithname) @@ -105,6 +110,7 @@ g.dashboard.new('my dashboard') * [`fn withRegex(value)`](#fn-querywithregex) * [`fn withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false)`](#fn-querywithsort) * [`obj generalOptions`](#obj-querygeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-querygeneraloptionswithcurrent) * [`fn withDescription(value)`](#fn-querygeneraloptionswithdescription) * [`fn withLabel(value)`](#fn-querygeneraloptionswithlabel) * [`fn withName(value)`](#fn-querygeneraloptionswithname) @@ -113,7 +119,7 @@ g.dashboard.new('my dashboard') * [`fn withNothing()`](#fn-querygeneraloptionsshowondashboardwithnothing) * [`fn withValueOnly()`](#fn-querygeneraloptionsshowondashboardwithvalueonly) * [`obj queryTypes`](#obj-queryquerytypes) - * [`fn withLabelValues(label, metric)`](#fn-queryquerytypeswithlabelvalues) + * [`fn withLabelValues(label, metric="")`](#fn-queryquerytypeswithlabelvalues) * [`obj refresh`](#obj-queryrefresh) * [`fn onLoad()`](#fn-queryrefreshonload) * [`fn onTime()`](#fn-queryrefreshontime) @@ -123,6 +129,7 @@ g.dashboard.new('my dashboard') * [`obj textbox`](#obj-textbox) * [`fn new(name, default="")`](#fn-textboxnew) * [`obj generalOptions`](#obj-textboxgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-textboxgeneraloptionswithcurrent) * [`fn withDescription(value)`](#fn-textboxgeneraloptionswithdescription) * [`fn withLabel(value)`](#fn-textboxgeneraloptionswithlabel) * [`fn withName(value)`](#fn-textboxgeneraloptionswithname) @@ -138,70 +145,102 @@ g.dashboard.new('my dashboard') #### fn adhoc.new -```ts -new(name, type, uid) +```jsonnet +adhoc.new(name, type, uid) ``` -`new` creates an adhoc template variable for datasource with `type` and `uid`. +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **uid** (`string`) -#### fn adhoc.newFromVariable +`new` creates an adhoc template variable for datasource with `type` and `uid`. +#### fn adhoc.newFromDatasourceVariable -```ts -newFromVariable(name, variable) +```jsonnet +adhoc.newFromDatasourceVariable(name, variable) ``` -Same as `new` but selecting the datasource from another template variable. +PARAMETERS: +* **name** (`string`) +* **variable** (`object`) + +Same as `new` but selecting the datasource from another template variable. #### obj adhoc.generalOptions +##### fn adhoc.generalOptions.withCurrent + +```jsonnet +adhoc.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + ##### fn adhoc.generalOptions.withDescription -```ts -withDescription(value) +```jsonnet +adhoc.generalOptions.withDescription(value) ``` +PARAMETERS: +* **value** (`string`) +Description of variable. It can be defined but `null`. ##### fn adhoc.generalOptions.withLabel -```ts -withLabel(value) +```jsonnet +adhoc.generalOptions.withLabel(value) ``` +PARAMETERS: +* **value** (`string`) +Optional display name ##### fn adhoc.generalOptions.withName -```ts -withName(value) +```jsonnet +adhoc.generalOptions.withName(value) ``` +PARAMETERS: +* **value** (`string`) +Name of variable ##### obj adhoc.generalOptions.showOnDashboard ###### fn adhoc.generalOptions.showOnDashboard.withLabelAndValue -```ts -withLabelAndValue() +```jsonnet +adhoc.generalOptions.showOnDashboard.withLabelAndValue() ``` ###### fn adhoc.generalOptions.showOnDashboard.withNothing -```ts -withNothing() +```jsonnet +adhoc.generalOptions.showOnDashboard.withNothing() ``` ###### fn adhoc.generalOptions.showOnDashboard.withValueOnly -```ts -withValueOnly() +```jsonnet +adhoc.generalOptions.showOnDashboard.withValueOnly() ``` @@ -211,62 +250,89 @@ withValueOnly() #### fn constant.new -```ts -new(name, value) +```jsonnet +constant.new(name, value) ``` -`new` creates a hidden constant template variable. +PARAMETERS: +* **name** (`string`) +* **value** (`string`) + +`new` creates a hidden constant template variable. #### obj constant.generalOptions +##### fn constant.generalOptions.withCurrent + +```jsonnet +constant.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + ##### fn constant.generalOptions.withDescription -```ts -withDescription(value) +```jsonnet +constant.generalOptions.withDescription(value) ``` +PARAMETERS: +* **value** (`string`) +Description of variable. It can be defined but `null`. ##### fn constant.generalOptions.withLabel -```ts -withLabel(value) +```jsonnet +constant.generalOptions.withLabel(value) ``` +PARAMETERS: +* **value** (`string`) +Optional display name ##### fn constant.generalOptions.withName -```ts -withName(value) +```jsonnet +constant.generalOptions.withName(value) ``` +PARAMETERS: +* **value** (`string`) +Name of variable ##### obj constant.generalOptions.showOnDashboard ###### fn constant.generalOptions.showOnDashboard.withLabelAndValue -```ts -withLabelAndValue() +```jsonnet +constant.generalOptions.showOnDashboard.withLabelAndValue() ``` ###### fn constant.generalOptions.showOnDashboard.withNothing -```ts -withNothing() +```jsonnet +constant.generalOptions.showOnDashboard.withNothing() ``` ###### fn constant.generalOptions.showOnDashboard.withValueOnly -```ts -withValueOnly() +```jsonnet +constant.generalOptions.showOnDashboard.withValueOnly() ``` @@ -276,10 +342,15 @@ withValueOnly() #### fn custom.new -```ts -new(name, values) +```jsonnet +custom.new(name, values) ``` +PARAMETERS: + +* **name** (`string`) +* **values** (`array`) + `new` creates a custom template variable. The `values` array accepts an object with key/value keys, if it's not an object @@ -293,57 +364,79 @@ Example: 12, ] - #### obj custom.generalOptions +##### fn custom.generalOptions.withCurrent + +```jsonnet +custom.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + ##### fn custom.generalOptions.withDescription -```ts -withDescription(value) +```jsonnet +custom.generalOptions.withDescription(value) ``` +PARAMETERS: +* **value** (`string`) +Description of variable. It can be defined but `null`. ##### fn custom.generalOptions.withLabel -```ts -withLabel(value) +```jsonnet +custom.generalOptions.withLabel(value) ``` +PARAMETERS: +* **value** (`string`) +Optional display name ##### fn custom.generalOptions.withName -```ts -withName(value) +```jsonnet +custom.generalOptions.withName(value) ``` +PARAMETERS: +* **value** (`string`) +Name of variable ##### obj custom.generalOptions.showOnDashboard ###### fn custom.generalOptions.showOnDashboard.withLabelAndValue -```ts -withLabelAndValue() +```jsonnet +custom.generalOptions.showOnDashboard.withLabelAndValue() ``` ###### fn custom.generalOptions.showOnDashboard.withNothing -```ts -withNothing() +```jsonnet +custom.generalOptions.showOnDashboard.withNothing() ``` ###### fn custom.generalOptions.showOnDashboard.withValueOnly -```ts -withValueOnly() +```jsonnet +custom.generalOptions.showOnDashboard.withValueOnly() ``` @@ -353,94 +446,133 @@ withValueOnly() ##### fn custom.selectionOptions.withIncludeAll -```ts -withIncludeAll(value=true, customAllValue) +```jsonnet +custom.selectionOptions.withIncludeAll(value=true, customAllValue) ``` +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`bool`) + `withIncludeAll` enables an option to include all variables. Optionally you can set a `customAllValue`. - ##### fn custom.selectionOptions.withMulti -```ts -withMulti(value=true) +```jsonnet +custom.selectionOptions.withMulti(value=true) ``` -Enable selecting multiple values. +PARAMETERS: +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. ### obj datasource #### fn datasource.new -```ts -new(name, type) +```jsonnet +datasource.new(name, type) ``` -`new` creates a datasource template variable. +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +`new` creates a datasource template variable. #### fn datasource.withRegex -```ts -withRegex(value) +```jsonnet +datasource.withRegex(value) ``` +PARAMETERS: + +* **value** (`string`) + `withRegex` filter for which data source instances to choose from in the variable value list. Example: `/^prod/` - #### obj datasource.generalOptions +##### fn datasource.generalOptions.withCurrent + +```jsonnet +datasource.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + ##### fn datasource.generalOptions.withDescription -```ts -withDescription(value) +```jsonnet +datasource.generalOptions.withDescription(value) ``` +PARAMETERS: +* **value** (`string`) +Description of variable. It can be defined but `null`. ##### fn datasource.generalOptions.withLabel -```ts -withLabel(value) +```jsonnet +datasource.generalOptions.withLabel(value) ``` +PARAMETERS: +* **value** (`string`) +Optional display name ##### fn datasource.generalOptions.withName -```ts -withName(value) +```jsonnet +datasource.generalOptions.withName(value) ``` +PARAMETERS: +* **value** (`string`) +Name of variable ##### obj datasource.generalOptions.showOnDashboard ###### fn datasource.generalOptions.showOnDashboard.withLabelAndValue -```ts -withLabelAndValue() +```jsonnet +datasource.generalOptions.showOnDashboard.withLabelAndValue() ``` ###### fn datasource.generalOptions.showOnDashboard.withNothing -```ts -withNothing() +```jsonnet +datasource.generalOptions.showOnDashboard.withNothing() ``` ###### fn datasource.generalOptions.showOnDashboard.withValueOnly -```ts -withValueOnly() +```jsonnet +datasource.generalOptions.showOnDashboard.withValueOnly() ``` @@ -450,97 +582,137 @@ withValueOnly() ##### fn datasource.selectionOptions.withIncludeAll -```ts -withIncludeAll(value=true, customAllValue) +```jsonnet +datasource.selectionOptions.withIncludeAll(value=true, customAllValue) ``` +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`bool`) + `withIncludeAll` enables an option to include all variables. Optionally you can set a `customAllValue`. - ##### fn datasource.selectionOptions.withMulti -```ts -withMulti(value=true) +```jsonnet +datasource.selectionOptions.withMulti(value=true) ``` -Enable selecting multiple values. +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +Enable selecting multiple values. ### obj interval #### fn interval.new -```ts -new(name, values) +```jsonnet +interval.new(name, values) ``` -`new` creates an interval template variable. +PARAMETERS: +* **name** (`string`) +* **values** (`array`) + +`new` creates an interval template variable. #### fn interval.withAutoOption -```ts -withAutoOption(count, minInterval) +```jsonnet +interval.withAutoOption(count, minInterval) ``` +PARAMETERS: + +* **count** (`number`) +* **minInterval** (`string`) + `withAutoOption` adds an options to dynamically calculate interval by dividing time range by the count specified. `minInterval' has to be either unit-less or end with one of the following units: "y, M, w, d, h, m, s, ms". - #### obj interval.generalOptions +##### fn interval.generalOptions.withCurrent + +```jsonnet +interval.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + ##### fn interval.generalOptions.withDescription -```ts -withDescription(value) +```jsonnet +interval.generalOptions.withDescription(value) ``` +PARAMETERS: +* **value** (`string`) +Description of variable. It can be defined but `null`. ##### fn interval.generalOptions.withLabel -```ts -withLabel(value) +```jsonnet +interval.generalOptions.withLabel(value) ``` +PARAMETERS: +* **value** (`string`) +Optional display name ##### fn interval.generalOptions.withName -```ts -withName(value) +```jsonnet +interval.generalOptions.withName(value) ``` +PARAMETERS: +* **value** (`string`) +Name of variable ##### obj interval.generalOptions.showOnDashboard ###### fn interval.generalOptions.showOnDashboard.withLabelAndValue -```ts -withLabelAndValue() +```jsonnet +interval.generalOptions.showOnDashboard.withLabelAndValue() ``` ###### fn interval.generalOptions.showOnDashboard.withNothing -```ts -withNothing() +```jsonnet +interval.generalOptions.showOnDashboard.withNothing() ``` ###### fn interval.generalOptions.showOnDashboard.withValueOnly -```ts -withValueOnly() +```jsonnet +interval.generalOptions.showOnDashboard.withValueOnly() ``` @@ -550,48 +722,74 @@ withValueOnly() #### fn query.new -```ts -new(name, query="") +```jsonnet +query.new(name, query="") ``` +PARAMETERS: + +* **name** (`string`) +* **query** (`string`) + - default value: `""` + Create a query template variable. `query` argument is optional, this can also be set with `query.queryTypes`. - #### fn query.withDatasource -```ts -withDatasource(type, uid) +```jsonnet +query.withDatasource(type, uid) ``` -Select a datasource for the variable template query. +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) +Select a datasource for the variable template query. #### fn query.withDatasourceFromVariable -```ts -withDatasourceFromVariable(variable) +```jsonnet +query.withDatasourceFromVariable(variable) ``` -Select the datasource from another template variable. +PARAMETERS: +* **variable** (`object`) + +Select the datasource from another template variable. #### fn query.withRegex -```ts -withRegex(value) +```jsonnet +query.withRegex(value) ``` +PARAMETERS: + +* **value** (`string`) + `withRegex` can extract part of a series name or metric node segment. Named capture groups can be used to separate the display text and value ([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). - #### fn query.withSort -```ts -withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false) +```jsonnet +query.withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false) ``` +PARAMETERS: + +* **i** (`number`) + - default value: `0` +* **type** (`string`) + - default value: `"alphabetical"` +* **asc** (`bool`) + - default value: `true` +* **caseInsensitive** (`bool`) + - default value: `false` + Choose how to sort the values in the dropdown. This can be called as `withSort() to use the integer values for each @@ -607,57 +805,79 @@ The numerical values are: - 5 - Alphabetical (case-insensitive, asc) - 6 - Alphabetical (case-insensitive, desc) - #### obj query.generalOptions +##### fn query.generalOptions.withCurrent + +```jsonnet +query.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + ##### fn query.generalOptions.withDescription -```ts -withDescription(value) +```jsonnet +query.generalOptions.withDescription(value) ``` +PARAMETERS: +* **value** (`string`) +Description of variable. It can be defined but `null`. ##### fn query.generalOptions.withLabel -```ts -withLabel(value) +```jsonnet +query.generalOptions.withLabel(value) ``` +PARAMETERS: +* **value** (`string`) +Optional display name ##### fn query.generalOptions.withName -```ts -withName(value) +```jsonnet +query.generalOptions.withName(value) ``` +PARAMETERS: +* **value** (`string`) +Name of variable ##### obj query.generalOptions.showOnDashboard ###### fn query.generalOptions.showOnDashboard.withLabelAndValue -```ts -withLabelAndValue() +```jsonnet +query.generalOptions.showOnDashboard.withLabelAndValue() ``` ###### fn query.generalOptions.showOnDashboard.withNothing -```ts -withNothing() +```jsonnet +query.generalOptions.showOnDashboard.withNothing() ``` ###### fn query.generalOptions.showOnDashboard.withValueOnly -```ts -withValueOnly() +```jsonnet +query.generalOptions.showOnDashboard.withValueOnly() ``` @@ -667,114 +887,156 @@ withValueOnly() ##### fn query.queryTypes.withLabelValues -```ts -withLabelValues(label, metric) +```jsonnet +query.queryTypes.withLabelValues(label, metric="") ``` -Construct a Prometheus template variable using `label_values()`. +PARAMETERS: +* **label** (`string`) +* **metric** (`string`) + - default value: `""` + +Construct a Prometheus template variable using `label_values()`. #### obj query.refresh ##### fn query.refresh.onLoad -```ts -onLoad() +```jsonnet +query.refresh.onLoad() ``` -Refresh label values on dashboard load. +Refresh label values on dashboard load. ##### fn query.refresh.onTime -```ts -onTime() +```jsonnet +query.refresh.onTime() ``` -Refresh label values on time range change. +Refresh label values on time range change. #### obj query.selectionOptions ##### fn query.selectionOptions.withIncludeAll -```ts -withIncludeAll(value=true, customAllValue) +```jsonnet +query.selectionOptions.withIncludeAll(value=true, customAllValue) ``` +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`bool`) + `withIncludeAll` enables an option to include all variables. Optionally you can set a `customAllValue`. - ##### fn query.selectionOptions.withMulti -```ts -withMulti(value=true) +```jsonnet +query.selectionOptions.withMulti(value=true) ``` -Enable selecting multiple values. +PARAMETERS: +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. ### obj textbox #### fn textbox.new -```ts -new(name, default="") +```jsonnet +textbox.new(name, default="") ``` -`new` creates a textbox template variable. +PARAMETERS: + +* **name** (`string`) +* **default** (`string`) + - default value: `""` +`new` creates a textbox template variable. #### obj textbox.generalOptions +##### fn textbox.generalOptions.withCurrent + +```jsonnet +textbox.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + ##### fn textbox.generalOptions.withDescription -```ts -withDescription(value) +```jsonnet +textbox.generalOptions.withDescription(value) ``` +PARAMETERS: +* **value** (`string`) +Description of variable. It can be defined but `null`. ##### fn textbox.generalOptions.withLabel -```ts -withLabel(value) +```jsonnet +textbox.generalOptions.withLabel(value) ``` +PARAMETERS: +* **value** (`string`) +Optional display name ##### fn textbox.generalOptions.withName -```ts -withName(value) +```jsonnet +textbox.generalOptions.withName(value) ``` +PARAMETERS: +* **value** (`string`) +Name of variable ##### obj textbox.generalOptions.showOnDashboard ###### fn textbox.generalOptions.showOnDashboard.withLabelAndValue -```ts -withLabelAndValue() +```jsonnet +textbox.generalOptions.showOnDashboard.withLabelAndValue() ``` ###### fn textbox.generalOptions.showOnDashboard.withNothing -```ts -withNothing() +```jsonnet +textbox.generalOptions.showOnDashboard.withNothing() ``` ###### fn textbox.generalOptions.showOnDashboard.withValueOnly -```ts -withValueOnly() +```jsonnet +textbox.generalOptions.showOnDashboard.withValueOnly() ``` diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/folder.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/folder.md new file mode 100644 index 0000000..2720db9 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/folder.md @@ -0,0 +1,45 @@ +# folder + +grafonnet.folder + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of the folder. +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Folder title +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique folder id. (will be k8s name) \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/librarypanel.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/librarypanel.md similarity index 65% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/librarypanel.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/librarypanel.md index 3ae7e2d..c4244ce 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/librarypanel.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/librarypanel.md @@ -38,167 +38,227 @@ grafonnet.librarypanel ### fn withDescription -```ts +```jsonnet withDescription(value) ``` -Panel description +PARAMETERS: + +* **value** (`string`) +Panel description ### fn withFolderUid -```ts +```jsonnet withFolderUid(value) ``` -Folder UID +PARAMETERS: + +* **value** (`string`) +Folder UID ### fn withMeta -```ts +```jsonnet withMeta(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withMetaMixin -```ts +```jsonnet withMetaMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withModel -```ts +```jsonnet withModel(value) ``` +PARAMETERS: + +* **value** (`object`) + TODO: should be the same panel schema defined in dashboard Typescript: Omit; - ### fn withModelMixin -```ts +```jsonnet withModelMixin(value) ``` +PARAMETERS: + +* **value** (`object`) + TODO: should be the same panel schema defined in dashboard Typescript: Omit; - ### fn withName -```ts +```jsonnet withName(value) ``` -Panel name (also saved in the model) +PARAMETERS: +* **value** (`string`) + +Panel name (also saved in the model) ### fn withSchemaVersion -```ts +```jsonnet withSchemaVersion(value) ``` -Dashboard version when this was saved (zero if unknown) +PARAMETERS: +* **value** (`integer`) + +Dashboard version when this was saved (zero if unknown) ### fn withType -```ts +```jsonnet withType(value) ``` -The panel type (from inside the model) +PARAMETERS: +* **value** (`string`) + +The panel type (from inside the model) ### fn withUid -```ts +```jsonnet withUid(value) ``` -Library element UID +PARAMETERS: +* **value** (`string`) + +Library element UID ### fn withVersion -```ts +```jsonnet withVersion(value) ``` -panel version, incremented each time the dashboard is updated. +PARAMETERS: +* **value** (`integer`) + +panel version, incremented each time the dashboard is updated. ### obj meta #### fn meta.withConnectedDashboards -```ts -withConnectedDashboards(value) +```jsonnet +meta.withConnectedDashboards(value) ``` +PARAMETERS: + +* **value** (`integer`) #### fn meta.withCreated -```ts -withCreated(value) +```jsonnet +meta.withCreated(value) ``` +PARAMETERS: + +* **value** (`string`) #### fn meta.withCreatedBy -```ts -withCreatedBy(value) +```jsonnet +meta.withCreatedBy(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn meta.withCreatedByMixin -```ts -withCreatedByMixin(value) +```jsonnet +meta.withCreatedByMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn meta.withFolderName -```ts -withFolderName(value) +```jsonnet +meta.withFolderName(value) ``` +PARAMETERS: + +* **value** (`string`) #### fn meta.withFolderUid -```ts -withFolderUid(value) +```jsonnet +meta.withFolderUid(value) ``` +PARAMETERS: + +* **value** (`string`) #### fn meta.withUpdated -```ts -withUpdated(value) +```jsonnet +meta.withUpdated(value) ``` +PARAMETERS: + +* **value** (`string`) #### fn meta.withUpdatedBy -```ts -withUpdatedBy(value) +```jsonnet +meta.withUpdatedBy(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn meta.withUpdatedByMixin -```ts -withUpdatedByMixin(value) +```jsonnet +meta.withUpdatedByMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### obj meta.createdBy @@ -206,26 +266,35 @@ withUpdatedByMixin(value) ##### fn meta.createdBy.withAvatarUrl -```ts -withAvatarUrl(value) +```jsonnet +meta.createdBy.withAvatarUrl(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn meta.createdBy.withId -```ts -withId(value) +```jsonnet +meta.createdBy.withId(value) ``` +PARAMETERS: + +* **value** (`integer`) ##### fn meta.createdBy.withName -```ts -withName(value) +```jsonnet +meta.createdBy.withName(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj meta.updatedBy @@ -233,24 +302,33 @@ withName(value) ##### fn meta.updatedBy.withAvatarUrl -```ts -withAvatarUrl(value) +```jsonnet +meta.updatedBy.withAvatarUrl(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn meta.updatedBy.withId -```ts -withId(value) +```jsonnet +meta.updatedBy.withId(value) ``` +PARAMETERS: + +* **value** (`integer`) ##### fn meta.updatedBy.withName -```ts -withName(value) +```jsonnet +meta.updatedBy.withName(value) ``` +PARAMETERS: + +* **value** (`string`) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/index.md new file mode 100644 index 0000000..41e6f0d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/index.md @@ -0,0 +1,646 @@ +# alertGroups + +grafonnet.panel.alertGroups + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlertmanager(value)`](#fn-optionswithalertmanager) + * [`fn withExpandAll(value=true)`](#fn-optionswithexpandall) + * [`fn withLabels(value)`](#fn-optionswithlabels) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new alertGroups panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withAlertmanager + +```jsonnet +options.withAlertmanager(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the alertmanager used as a source for alerts +#### fn options.withExpandAll + +```jsonnet +options.withExpandAll(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Expand all alert groups by default +#### fn options.withLabels + +```jsonnet +options.withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Comma-separated list of values used to filter alert results +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/override.md similarity index 71% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/fieldOverride.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/override.md index 3e2667b..2997ad7 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/fieldOverride.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/override.md @@ -1,12 +1,12 @@ -# fieldOverride +# override Overrides allow you to customize visualization settings for specific fields or series. This is accomplished by adding an override rule that targets a particular set of fields and that can each define multiple options. ```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( panel.standardOptions.withDecimals(2) + panel.standardOptions.withUnit('s') ) @@ -43,152 +43,202 @@ fieldOverride.byType.new('number') #### fn byName.new -```ts -new(value) +```jsonnet +byName.new(value) ``` -`new` creates a new override of type `byName`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byName`. #### fn byName.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byName.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byName.withProperty -```ts -withProperty(id, value) +```jsonnet +byName.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byQuery #### fn byQuery.new -```ts -new(value) +```jsonnet +byQuery.new(value) ``` -`new` creates a new override of type `byQuery`. +PARAMETERS: + +* **value** (`string`) +`new` creates a new override of type `byFrameRefID`. #### fn byQuery.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byQuery.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byQuery.withProperty -```ts -withProperty(id, value) +```jsonnet +byQuery.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byRegexp #### fn byRegexp.new -```ts -new(value) +```jsonnet +byRegexp.new(value) ``` -`new` creates a new override of type `byRegexp`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. #### fn byRegexp.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byRegexp.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byRegexp.withProperty -```ts -withProperty(id, value) +```jsonnet +byRegexp.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byType #### fn byType.new -```ts -new(value) +```jsonnet +byType.new(value) ``` -`new` creates a new override of type `byType`. +PARAMETERS: + +* **value** (`string`) +`new` creates a new override of type `byType`. #### fn byType.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byType.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byType.withProperty -```ts -withProperty(id, value) +```jsonnet +byType.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byValue #### fn byValue.new -```ts -new(value) +```jsonnet +byValue.new(value) ``` -`new` creates a new override of type `byValue`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byValue`. #### fn byValue.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byValue.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byValue.withProperty -```ts -withProperty(id, value) +```jsonnet +byValue.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertGroups/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/index.md new file mode 100644 index 0000000..6a2b1e8 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/index.md @@ -0,0 +1,1177 @@ +# alertList + +grafonnet.panel.alertList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlertListOptions(value)`](#fn-optionswithalertlistoptions) + * [`fn withAlertListOptionsMixin(value)`](#fn-optionswithalertlistoptionsmixin) + * [`fn withUnifiedAlertListOptions(value)`](#fn-optionswithunifiedalertlistoptions) + * [`fn withUnifiedAlertListOptionsMixin(value)`](#fn-optionswithunifiedalertlistoptionsmixin) + * [`obj AlertListOptions`](#obj-optionsalertlistoptions) + * [`fn withAlertName(value)`](#fn-optionsalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsalertlistoptionswithdashboardalerts) + * [`fn withDashboardTitle(value)`](#fn-optionsalertlistoptionswithdashboardtitle) + * [`fn withFolderId(value)`](#fn-optionsalertlistoptionswithfolderid) + * [`fn withMaxItems(value)`](#fn-optionsalertlistoptionswithmaxitems) + * [`fn withShowOptions(value)`](#fn-optionsalertlistoptionswithshowoptions) + * [`fn withSortOrder(value)`](#fn-optionsalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsalertlistoptionswithstatefiltermixin) + * [`fn withTags(value)`](#fn-optionsalertlistoptionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionsalertlistoptionswithtagsmixin) + * [`obj stateFilter`](#obj-optionsalertlistoptionsstatefilter) + * [`fn withAlerting(value=true)`](#fn-optionsalertlistoptionsstatefilterwithalerting) + * [`fn withExecutionError(value=true)`](#fn-optionsalertlistoptionsstatefilterwithexecutionerror) + * [`fn withNoData(value=true)`](#fn-optionsalertlistoptionsstatefilterwithnodata) + * [`fn withOk(value=true)`](#fn-optionsalertlistoptionsstatefilterwithok) + * [`fn withPaused(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpaused) + * [`fn withPending(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpending) + * [`obj UnifiedAlertListOptions`](#obj-optionsunifiedalertlistoptions) + * [`fn withAlertInstanceLabelFilter(value)`](#fn-optionsunifiedalertlistoptionswithalertinstancelabelfilter) + * [`fn withAlertName(value)`](#fn-optionsunifiedalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsunifiedalertlistoptionswithdashboardalerts) + * [`fn withDatasource(value)`](#fn-optionsunifiedalertlistoptionswithdatasource) + * [`fn withFolder(value)`](#fn-optionsunifiedalertlistoptionswithfolder) + * [`fn withFolderMixin(value)`](#fn-optionsunifiedalertlistoptionswithfoldermixin) + * [`fn withGroupBy(value)`](#fn-optionsunifiedalertlistoptionswithgroupby) + * [`fn withGroupByMixin(value)`](#fn-optionsunifiedalertlistoptionswithgroupbymixin) + * [`fn withGroupMode(value)`](#fn-optionsunifiedalertlistoptionswithgroupmode) + * [`fn withMaxItems(value)`](#fn-optionsunifiedalertlistoptionswithmaxitems) + * [`fn withShowInstances(value=true)`](#fn-optionsunifiedalertlistoptionswithshowinstances) + * [`fn withSortOrder(value)`](#fn-optionsunifiedalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsunifiedalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsunifiedalertlistoptionswithstatefiltermixin) + * [`fn withViewMode(value)`](#fn-optionsunifiedalertlistoptionswithviewmode) + * [`obj folder`](#obj-optionsunifiedalertlistoptionsfolder) + * [`fn withId(value)`](#fn-optionsunifiedalertlistoptionsfolderwithid) + * [`fn withTitle(value)`](#fn-optionsunifiedalertlistoptionsfolderwithtitle) + * [`obj stateFilter`](#obj-optionsunifiedalertlistoptionsstatefilter) + * [`fn withError(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwitherror) + * [`fn withFiring(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithfiring) + * [`fn withInactive(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithinactive) + * [`fn withNoData(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnodata) + * [`fn withNormal(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnormal) + * [`fn withPending(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithpending) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new alertlist panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withAlertListOptions + +```jsonnet +options.withAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withAlertListOptionsMixin + +```jsonnet +options.withAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptions + +```jsonnet +options.withUnifiedAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptionsMixin + +```jsonnet +options.withUnifiedAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.AlertListOptions + + +##### fn options.AlertListOptions.withAlertName + +```jsonnet +options.AlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withDashboardAlerts + +```jsonnet +options.AlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.AlertListOptions.withDashboardTitle + +```jsonnet +options.AlertListOptions.withDashboardTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withFolderId + +```jsonnet +options.AlertListOptions.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withMaxItems + +```jsonnet +options.AlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withShowOptions + +```jsonnet +options.AlertListOptions.withShowOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"current"`, `"changes"` + + +##### fn options.AlertListOptions.withSortOrder + +```jsonnet +options.AlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.AlertListOptions.withStateFilter + +```jsonnet +options.AlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withStateFilterMixin + +```jsonnet +options.AlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withTags + +```jsonnet +options.AlertListOptions.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.AlertListOptions.withTagsMixin + +```jsonnet +options.AlertListOptions.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### obj options.AlertListOptions.stateFilter + + +###### fn options.AlertListOptions.stateFilter.withAlerting + +```jsonnet +options.AlertListOptions.stateFilter.withAlerting(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withExecutionError + +```jsonnet +options.AlertListOptions.stateFilter.withExecutionError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withNoData + +```jsonnet +options.AlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withOk + +```jsonnet +options.AlertListOptions.stateFilter.withOk(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPaused + +```jsonnet +options.AlertListOptions.stateFilter.withPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPending + +```jsonnet +options.AlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj options.UnifiedAlertListOptions + + +##### fn options.UnifiedAlertListOptions.withAlertInstanceLabelFilter + +```jsonnet +options.UnifiedAlertListOptions.withAlertInstanceLabelFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withAlertName + +```jsonnet +options.UnifiedAlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withDashboardAlerts + +```jsonnet +options.UnifiedAlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withDatasource + +```jsonnet +options.UnifiedAlertListOptions.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withFolder + +```jsonnet +options.UnifiedAlertListOptions.withFolder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withFolderMixin + +```jsonnet +options.UnifiedAlertListOptions.withFolderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withGroupBy + +```jsonnet +options.UnifiedAlertListOptions.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupByMixin + +```jsonnet +options.UnifiedAlertListOptions.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupMode + +```jsonnet +options.UnifiedAlertListOptions.withGroupMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"default"`, `"custom"` + + +##### fn options.UnifiedAlertListOptions.withMaxItems + +```jsonnet +options.UnifiedAlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.UnifiedAlertListOptions.withShowInstances + +```jsonnet +options.UnifiedAlertListOptions.withShowInstances(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withSortOrder + +```jsonnet +options.UnifiedAlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.UnifiedAlertListOptions.withStateFilter + +```jsonnet +options.UnifiedAlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withStateFilterMixin + +```jsonnet +options.UnifiedAlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withViewMode + +```jsonnet +options.UnifiedAlertListOptions.withViewMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"stat"` + + +##### obj options.UnifiedAlertListOptions.folder + + +###### fn options.UnifiedAlertListOptions.folder.withId + +```jsonnet +options.UnifiedAlertListOptions.folder.withId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.UnifiedAlertListOptions.folder.withTitle + +```jsonnet +options.UnifiedAlertListOptions.folder.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.UnifiedAlertListOptions.stateFilter + + +###### fn options.UnifiedAlertListOptions.stateFilter.withError + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withFiring + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withFiring(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withInactive + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withInactive(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNoData + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNormal + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNormal(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withPending + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/override.md similarity index 71% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/fieldOverride.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/override.md index 3e2667b..2997ad7 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/fieldOverride.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/override.md @@ -1,12 +1,12 @@ -# fieldOverride +# override Overrides allow you to customize visualization settings for specific fields or series. This is accomplished by adding an override rule that targets a particular set of fields and that can each define multiple options. ```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( panel.standardOptions.withDecimals(2) + panel.standardOptions.withUnit('s') ) @@ -43,152 +43,202 @@ fieldOverride.byType.new('number') #### fn byName.new -```ts -new(value) +```jsonnet +byName.new(value) ``` -`new` creates a new override of type `byName`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byName`. #### fn byName.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byName.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byName.withProperty -```ts -withProperty(id, value) +```jsonnet +byName.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byQuery #### fn byQuery.new -```ts -new(value) +```jsonnet +byQuery.new(value) ``` -`new` creates a new override of type `byQuery`. +PARAMETERS: + +* **value** (`string`) +`new` creates a new override of type `byFrameRefID`. #### fn byQuery.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byQuery.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byQuery.withProperty -```ts -withProperty(id, value) +```jsonnet +byQuery.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byRegexp #### fn byRegexp.new -```ts -new(value) +```jsonnet +byRegexp.new(value) ``` -`new` creates a new override of type `byRegexp`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. #### fn byRegexp.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byRegexp.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byRegexp.withProperty -```ts -withProperty(id, value) +```jsonnet +byRegexp.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byType #### fn byType.new -```ts -new(value) +```jsonnet +byType.new(value) ``` -`new` creates a new override of type `byType`. +PARAMETERS: + +* **value** (`string`) +`new` creates a new override of type `byType`. #### fn byType.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byType.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byType.withProperty -```ts -withProperty(id, value) +```jsonnet +byType.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byValue #### fn byValue.new -```ts -new(value) +```jsonnet +byValue.new(value) ``` -`new` creates a new override of type `byValue`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byValue`. #### fn byValue.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byValue.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byValue.withProperty -```ts -withProperty(id, value) +```jsonnet +byValue.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/alertList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/index.md new file mode 100644 index 0000000..d2471a5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/index.md @@ -0,0 +1,750 @@ +# annotationsList + +grafonnet.panel.annotationsList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLimit(value=10)`](#fn-optionswithlimit) + * [`fn withNavigateAfter(value="10m")`](#fn-optionswithnavigateafter) + * [`fn withNavigateBefore(value="10m")`](#fn-optionswithnavigatebefore) + * [`fn withNavigateToPanel(value=true)`](#fn-optionswithnavigatetopanel) + * [`fn withOnlyFromThisDashboard(value=true)`](#fn-optionswithonlyfromthisdashboard) + * [`fn withOnlyInTimeRange(value=true)`](#fn-optionswithonlyintimerange) + * [`fn withShowTags(value=true)`](#fn-optionswithshowtags) + * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) + * [`fn withShowUser(value=true)`](#fn-optionswithshowuser) + * [`fn withTags(value)`](#fn-optionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new annotationsList panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLimit + +```jsonnet +options.withLimit(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withNavigateAfter + +```jsonnet +options.withNavigateAfter(value="10m") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"10m"` + + +#### fn options.withNavigateBefore + +```jsonnet +options.withNavigateBefore(value="10m") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"10m"` + + +#### fn options.withNavigateToPanel + +```jsonnet +options.withNavigateToPanel(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withOnlyFromThisDashboard + +```jsonnet +options.withOnlyFromThisDashboard(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withOnlyInTimeRange + +```jsonnet +options.withOnlyInTimeRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTags + +```jsonnet +options.withShowTags(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTime + +```jsonnet +options.withShowTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowUser + +```jsonnet +options.withShowUser(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withTags + +```jsonnet +options.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTagsMixin + +```jsonnet +options.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/override.md similarity index 71% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/fieldOverride.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/override.md index 3e2667b..2997ad7 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/fieldOverride.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/override.md @@ -1,12 +1,12 @@ -# fieldOverride +# override Overrides allow you to customize visualization settings for specific fields or series. This is accomplished by adding an override rule that targets a particular set of fields and that can each define multiple options. ```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( panel.standardOptions.withDecimals(2) + panel.standardOptions.withUnit('s') ) @@ -43,152 +43,202 @@ fieldOverride.byType.new('number') #### fn byName.new -```ts -new(value) +```jsonnet +byName.new(value) ``` -`new` creates a new override of type `byName`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byName`. #### fn byName.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byName.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byName.withProperty -```ts -withProperty(id, value) +```jsonnet +byName.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byQuery #### fn byQuery.new -```ts -new(value) +```jsonnet +byQuery.new(value) ``` -`new` creates a new override of type `byQuery`. +PARAMETERS: + +* **value** (`string`) +`new` creates a new override of type `byFrameRefID`. #### fn byQuery.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byQuery.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byQuery.withProperty -```ts -withProperty(id, value) +```jsonnet +byQuery.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byRegexp #### fn byRegexp.new -```ts -new(value) +```jsonnet +byRegexp.new(value) ``` -`new` creates a new override of type `byRegexp`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. #### fn byRegexp.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byRegexp.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byRegexp.withProperty -```ts -withProperty(id, value) +```jsonnet +byRegexp.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byType #### fn byType.new -```ts -new(value) +```jsonnet +byType.new(value) ``` -`new` creates a new override of type `byType`. +PARAMETERS: + +* **value** (`string`) +`new` creates a new override of type `byType`. #### fn byType.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byType.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byType.withProperty -```ts -withProperty(id, value) +```jsonnet +byType.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byValue #### fn byValue.new -```ts -new(value) +```jsonnet +byValue.new(value) ``` -`new` creates a new override of type `byValue`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byValue`. #### fn byValue.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byValue.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byValue.withProperty -```ts -withProperty(id, value) +```jsonnet +byValue.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/annotationsList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/index.md new file mode 100644 index 0000000..a829cf4 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/index.md @@ -0,0 +1,1359 @@ +# barChart + +grafonnet.panel.barChart + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBarRadius(value=0)`](#fn-optionswithbarradius) + * [`fn withBarWidth(value=0.97)`](#fn-optionswithbarwidth) + * [`fn withColorByField(value)`](#fn-optionswithcolorbyfield) + * [`fn withFullHighlight(value=true)`](#fn-optionswithfullhighlight) + * [`fn withGroupWidth(value=0.7)`](#fn-optionswithgroupwidth) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withStacking(value)`](#fn-optionswithstacking) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withXField(value)`](#fn-optionswithxfield) + * [`fn withXTickLabelMaxLength(value)`](#fn-optionswithxticklabelmaxlength) + * [`fn withXTickLabelRotation(value=0)`](#fn-optionswithxticklabelrotation) + * [`fn withXTickLabelSpacing(value=0)`](#fn-optionswithxticklabelspacing) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new barChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=80) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `80` + +Controls the fill opacity of the bars. +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. +Gradient appearance is influenced by the Fill opacity setting. +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls line width of the bars. +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBarRadius + +```jsonnet +options.withBarRadius(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Controls the radius of each bar. +#### fn options.withBarWidth + +```jsonnet +options.withBarWidth(value=0.97) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.97` + +Controls the width of bars. 1 = Max width, 0 = Min width. +#### fn options.withColorByField + +```jsonnet +options.withColorByField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Use the color value for a sibling field to color each bar value. +#### fn options.withFullHighlight + +```jsonnet +options.withFullHighlight(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enables mode which highlights the entire bar area and shows tooltip when cursor +hovers over highlighted area +#### fn options.withGroupWidth + +```jsonnet +options.withGroupWidth(value=0.7) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.7` + +Controls the width of groups. 1 = max with, 0 = min width. +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the orientation of the bar chart, either vertical or horizontal. +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +This controls whether values are shown on top or to the left of bars. +#### fn options.withStacking + +```jsonnet +options.withStacking(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls whether bars are stacked or not, either normally or in percent mode. +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withXField + +```jsonnet +options.withXField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Manually select which field from the dataset to represent the x field. +#### fn options.withXTickLabelMaxLength + +```jsonnet +options.withXTickLabelMaxLength(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Sets the max length that a label can have before it is truncated. +#### fn options.withXTickLabelRotation + +```jsonnet +options.withXTickLabelRotation(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Controls the rotation of the x axis labels. +#### fn options.withXTickLabelSpacing + +```jsonnet +options.withXTickLabelSpacing(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Controls the spacing between x axis labels. +negative values indicate backwards skipping behavior +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/override.md similarity index 71% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/fieldOverride.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/override.md index 3e2667b..2997ad7 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/fieldOverride.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/override.md @@ -1,12 +1,12 @@ -# fieldOverride +# override Overrides allow you to customize visualization settings for specific fields or series. This is accomplished by adding an override rule that targets a particular set of fields and that can each define multiple options. ```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( panel.standardOptions.withDecimals(2) + panel.standardOptions.withUnit('s') ) @@ -43,152 +43,202 @@ fieldOverride.byType.new('number') #### fn byName.new -```ts -new(value) +```jsonnet +byName.new(value) ``` -`new` creates a new override of type `byName`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byName`. #### fn byName.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byName.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byName.withProperty -```ts -withProperty(id, value) +```jsonnet +byName.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byQuery #### fn byQuery.new -```ts -new(value) +```jsonnet +byQuery.new(value) ``` -`new` creates a new override of type `byQuery`. +PARAMETERS: + +* **value** (`string`) +`new` creates a new override of type `byFrameRefID`. #### fn byQuery.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byQuery.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byQuery.withProperty -```ts -withProperty(id, value) +```jsonnet +byQuery.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byRegexp #### fn byRegexp.new -```ts -new(value) +```jsonnet +byRegexp.new(value) ``` -`new` creates a new override of type `byRegexp`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. #### fn byRegexp.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byRegexp.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byRegexp.withProperty -```ts -withProperty(id, value) +```jsonnet +byRegexp.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byType #### fn byType.new -```ts -new(value) +```jsonnet +byType.new(value) ``` -`new` creates a new override of type `byType`. +PARAMETERS: + +* **value** (`string`) +`new` creates a new override of type `byType`. #### fn byType.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byType.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byType.withProperty -```ts -withProperty(id, value) +```jsonnet +byType.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - ### obj byValue #### fn byValue.new -```ts -new(value) +```jsonnet +byValue.new(value) ``` -`new` creates a new override of type `byValue`. +PARAMETERS: +* **value** (`string`) + +`new` creates a new override of type `byValue`. #### fn byValue.withPropertiesFromOptions -```ts -withPropertiesFromOptions(options) +```jsonnet +byValue.withPropertiesFromOptions(options) ``` +PARAMETERS: + +* **options** (`object`) + `withPropertiesFromOptions` takes an object with properties that need to be overridden. See example code above. - #### fn byValue.withProperty -```ts -withProperty(id, value) +```jsonnet +byValue.withProperty(id, value) ``` +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + `withProperty` adds a property that needs to be overridden. This function can be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/index.md new file mode 100644 index 0000000..cbca968 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/index.md @@ -0,0 +1,842 @@ +# barGauge + +grafonnet.panel.barGauge + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDisplayMode(value)`](#fn-optionswithdisplaymode) + * [`fn withMinVizHeight(value=10)`](#fn-optionswithminvizheight) + * [`fn withMinVizWidth(value=0)`](#fn-optionswithminvizwidth) + * [`fn withNamePlacement(value)`](#fn-optionswithnameplacement) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowUnfilled(value=true)`](#fn-optionswithshowunfilled) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withValueMode(value)`](#fn-optionswithvaluemode) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new barGauge panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDisplayMode + +```jsonnet +options.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"lcd"`, `"gradient"` + +Enum expressing the possible display modes +for the bar gauge component of Grafana UI +#### fn options.withMinVizHeight + +```jsonnet +options.withMinVizHeight(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withMinVizWidth + +```jsonnet +options.withMinVizWidth(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +#### fn options.withNamePlacement + +```jsonnet +options.withNamePlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"left"` + +Allows for the bar gauge name to be placed explicitly +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowUnfilled + +```jsonnet +options.withShowUnfilled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withValueMode + +```jsonnet +options.withValueMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"color"`, `"text"`, `"hidden"` + +Allows for the table cell gauge display type to set the gauge mode. +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/barGauge/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/index.md new file mode 100644 index 0000000..eb9117a --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/index.md @@ -0,0 +1,1640 @@ +# candlestick + +grafonnet.panel.candlestick + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCandleStyle(value)`](#fn-optionswithcandlestyle) + * [`fn withColorStrategy(value)`](#fn-optionswithcolorstrategy) + * [`fn withColors(value)`](#fn-optionswithcolors) + * [`fn withColorsMixin(value)`](#fn-optionswithcolorsmixin) + * [`fn withFields(value={})`](#fn-optionswithfields) + * [`fn withFieldsMixin(value={})`](#fn-optionswithfieldsmixin) + * [`fn withIncludeAllFields(value=true)`](#fn-optionswithincludeallfields) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`obj colors`](#obj-optionscolors) + * [`fn withDown(value="red")`](#fn-optionscolorswithdown) + * [`fn withFlat(value="gray")`](#fn-optionscolorswithflat) + * [`fn withUp(value="green")`](#fn-optionscolorswithup) + * [`obj fields`](#obj-optionsfields) + * [`fn withCandlestickFieldMap(value)`](#fn-optionsfieldswithcandlestickfieldmap) + * [`fn withCandlestickFieldMapMixin(value)`](#fn-optionsfieldswithcandlestickfieldmapmixin) + * [`obj CandlestickFieldMap`](#obj-optionsfieldscandlestickfieldmap) + * [`fn withClose(value)`](#fn-optionsfieldscandlestickfieldmapwithclose) + * [`fn withHigh(value)`](#fn-optionsfieldscandlestickfieldmapwithhigh) + * [`fn withLow(value)`](#fn-optionsfieldscandlestickfieldmapwithlow) + * [`fn withOpen(value)`](#fn-optionsfieldscandlestickfieldmapwithopen) + * [`fn withVolume(value)`](#fn-optionsfieldscandlestickfieldmapwithvolume) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new candlestick panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`integer`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCandleStyle + +```jsonnet +options.withCandleStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the style of the candlesticks +#### fn options.withColorStrategy + +```jsonnet +options.withColorStrategy(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the color strategy for the candlesticks +#### fn options.withColors + +```jsonnet +options.withColors(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withColorsMixin + +```jsonnet +options.withColorsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withFields + +```jsonnet +options.withFields(value={}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{}` + +Map fields to appropriate dimension +#### fn options.withFieldsMixin + +```jsonnet +options.withFieldsMixin(value={}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{}` + +Map fields to appropriate dimension +#### fn options.withIncludeAllFields + +```jsonnet +options.withIncludeAllFields(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When enabled, all fields will be sent to the graph +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets which dimensions are used for the visualization +#### obj options.colors + + +##### fn options.colors.withDown + +```jsonnet +options.colors.withDown(value="red") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"red"` + + +##### fn options.colors.withFlat + +```jsonnet +options.colors.withFlat(value="gray") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"gray"` + + +##### fn options.colors.withUp + +```jsonnet +options.colors.withUp(value="green") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"green"` + + +#### obj options.fields + + +##### fn options.fields.withCandlestickFieldMap + +```jsonnet +options.fields.withCandlestickFieldMap(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.fields.withCandlestickFieldMapMixin + +```jsonnet +options.fields.withCandlestickFieldMapMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### obj options.fields.CandlestickFieldMap + + +###### fn options.fields.CandlestickFieldMap.withClose + +```jsonnet +options.fields.CandlestickFieldMap.withClose(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the final (end) value of the given period +###### fn options.fields.CandlestickFieldMap.withHigh + +```jsonnet +options.fields.CandlestickFieldMap.withHigh(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the highest value of the given period +###### fn options.fields.CandlestickFieldMap.withLow + +```jsonnet +options.fields.CandlestickFieldMap.withLow(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the lowest value of the given period +###### fn options.fields.CandlestickFieldMap.withOpen + +```jsonnet +options.fields.CandlestickFieldMap.withOpen(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the starting value of the given period +###### fn options.fields.CandlestickFieldMap.withVolume + +```jsonnet +options.fields.CandlestickFieldMap.withVolume(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the sample count in the given period. (e.g. number of trades) +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/candlestick/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/index.md new file mode 100644 index 0000000..8b89b28 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/index.md @@ -0,0 +1,715 @@ +# canvas + +grafonnet.panel.canvas + +## Subpackages + +* [options.root.elements](options/root/elements/index.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withInlineEditing(value=true)`](#fn-optionswithinlineediting) + * [`fn withRoot(value)`](#fn-optionswithroot) + * [`fn withRootMixin(value)`](#fn-optionswithrootmixin) + * [`fn withShowAdvancedTypes(value=true)`](#fn-optionswithshowadvancedtypes) + * [`obj root`](#obj-optionsroot) + * [`fn withElements(value)`](#fn-optionsrootwithelements) + * [`fn withElementsMixin(value)`](#fn-optionsrootwithelementsmixin) + * [`fn withName(value)`](#fn-optionsrootwithname) + * [`fn withType(value)`](#fn-optionsrootwithtype) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new canvas panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withInlineEditing + +```jsonnet +options.withInlineEditing(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable inline editing +#### fn options.withRoot + +```jsonnet +options.withRoot(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The root element of canvas (frame), where all canvas elements are nested +TODO: Figure out how to define a default value for this +#### fn options.withRootMixin + +```jsonnet +options.withRootMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The root element of canvas (frame), where all canvas elements are nested +TODO: Figure out how to define a default value for this +#### fn options.withShowAdvancedTypes + +```jsonnet +options.withShowAdvancedTypes(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show all available element types +#### obj options.root + + +##### fn options.root.withElements + +```jsonnet +options.root.withElements(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The list of canvas elements attached to the root element +##### fn options.root.withElementsMixin + +```jsonnet +options.root.withElementsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The list of canvas elements attached to the root element +##### fn options.root.withName + +```jsonnet +options.root.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the root element +##### fn options.root.withType + +```jsonnet +options.root.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"frame"` + +Type of root element (frame) +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/options/root/elements/connections.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/options/root/elements/connections.md new file mode 100644 index 0000000..e8e6226 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/options/root/elements/connections.md @@ -0,0 +1,278 @@ +# connections + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withColorMixin(value)`](#fn-withcolormixin) +* [`fn withPath(value)`](#fn-withpath) +* [`fn withSize(value)`](#fn-withsize) +* [`fn withSizeMixin(value)`](#fn-withsizemixin) +* [`fn withSource(value)`](#fn-withsource) +* [`fn withSourceMixin(value)`](#fn-withsourcemixin) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withTargetMixin(value)`](#fn-withtargetmixin) +* [`fn withTargetName(value)`](#fn-withtargetname) +* [`obj color`](#obj-color) + * [`fn withField(value)`](#fn-colorwithfield) + * [`fn withFixed(value)`](#fn-colorwithfixed) +* [`obj size`](#obj-size) + * [`fn withField(value)`](#fn-sizewithfield) + * [`fn withFixed(value)`](#fn-sizewithfixed) + * [`fn withMax(value)`](#fn-sizewithmax) + * [`fn withMin(value)`](#fn-sizewithmin) + * [`fn withMode(value)`](#fn-sizewithmode) +* [`obj source`](#obj-source) + * [`fn withX(value)`](#fn-sourcewithx) + * [`fn withY(value)`](#fn-sourcewithy) +* [`obj target`](#obj-target) + * [`fn withX(value)`](#fn-targetwithx) + * [`fn withY(value)`](#fn-targetwithy) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withColorMixin + +```jsonnet +withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPath + +```jsonnet +withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"straight"` + + +### fn withSize + +```jsonnet +withSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSizeMixin + +```jsonnet +withSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSource + +```jsonnet +withSource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceMixin + +```jsonnet +withSourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetMixin + +```jsonnet +withTargetMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetName + +```jsonnet +withTargetName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj color + + +#### fn color.withField + +```jsonnet +color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn color.withFixed + +```jsonnet +color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj size + + +#### fn size.withField + +```jsonnet +size.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn size.withFixed + +```jsonnet +size.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMax + +```jsonnet +size.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMin + +```jsonnet +size.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMode + +```jsonnet +size.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +### obj source + + +#### fn source.withX + +```jsonnet +source.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn source.withY + +```jsonnet +source.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj target + + +#### fn target.withX + +```jsonnet +target.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn target.withY + +```jsonnet +target.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/options/root/elements/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/options/root/elements/index.md new file mode 100644 index 0000000..7892a2f --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/options/root/elements/index.md @@ -0,0 +1,476 @@ +# elements + + + +## Subpackages + +* [connections](connections.md) + +## Index + +* [`fn withBackground(value)`](#fn-withbackground) +* [`fn withBackgroundMixin(value)`](#fn-withbackgroundmixin) +* [`fn withBorder(value)`](#fn-withborder) +* [`fn withBorderMixin(value)`](#fn-withbordermixin) +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConnections(value)`](#fn-withconnections) +* [`fn withConnectionsMixin(value)`](#fn-withconnectionsmixin) +* [`fn withConstraint(value)`](#fn-withconstraint) +* [`fn withConstraintMixin(value)`](#fn-withconstraintmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withPlacement(value)`](#fn-withplacement) +* [`fn withPlacementMixin(value)`](#fn-withplacementmixin) +* [`fn withType(value)`](#fn-withtype) +* [`obj background`](#obj-background) + * [`fn withColor(value)`](#fn-backgroundwithcolor) + * [`fn withColorMixin(value)`](#fn-backgroundwithcolormixin) + * [`fn withImage(value)`](#fn-backgroundwithimage) + * [`fn withImageMixin(value)`](#fn-backgroundwithimagemixin) + * [`fn withSize(value)`](#fn-backgroundwithsize) + * [`obj color`](#obj-backgroundcolor) + * [`fn withField(value)`](#fn-backgroundcolorwithfield) + * [`fn withFixed(value)`](#fn-backgroundcolorwithfixed) + * [`obj image`](#obj-backgroundimage) + * [`fn withField(value)`](#fn-backgroundimagewithfield) + * [`fn withFixed(value)`](#fn-backgroundimagewithfixed) + * [`fn withMode(value)`](#fn-backgroundimagewithmode) +* [`obj border`](#obj-border) + * [`fn withColor(value)`](#fn-borderwithcolor) + * [`fn withColorMixin(value)`](#fn-borderwithcolormixin) + * [`fn withWidth(value)`](#fn-borderwithwidth) + * [`obj color`](#obj-bordercolor) + * [`fn withField(value)`](#fn-bordercolorwithfield) + * [`fn withFixed(value)`](#fn-bordercolorwithfixed) +* [`obj constraint`](#obj-constraint) + * [`fn withHorizontal(value)`](#fn-constraintwithhorizontal) + * [`fn withVertical(value)`](#fn-constraintwithvertical) +* [`obj placement`](#obj-placement) + * [`fn withBottom(value)`](#fn-placementwithbottom) + * [`fn withHeight(value)`](#fn-placementwithheight) + * [`fn withLeft(value)`](#fn-placementwithleft) + * [`fn withRight(value)`](#fn-placementwithright) + * [`fn withTop(value)`](#fn-placementwithtop) + * [`fn withWidth(value)`](#fn-placementwithwidth) + +## Fields + +### fn withBackground + +```jsonnet +withBackground(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBackgroundMixin + +```jsonnet +withBackgroundMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBorder + +```jsonnet +withBorder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBorderMixin + +```jsonnet +withBorderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`string`) + +TODO: figure out how to define this (element config(s)) +### fn withConnections + +```jsonnet +withConnections(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConnectionsMixin + +```jsonnet +withConnectionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConstraint + +```jsonnet +withConstraint(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConstraintMixin + +```jsonnet +withConstraintMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPlacement + +```jsonnet +withPlacement(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPlacementMixin + +```jsonnet +withPlacementMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj background + + +#### fn background.withColor + +```jsonnet +background.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn background.withColorMixin + +```jsonnet +background.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn background.withImage + +```jsonnet +background.withImage(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Links to a resource (image/svg path) +#### fn background.withImageMixin + +```jsonnet +background.withImageMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Links to a resource (image/svg path) +#### fn background.withSize + +```jsonnet +background.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"original"`, `"contain"`, `"cover"`, `"fill"`, `"tile"` + + +#### obj background.color + + +##### fn background.color.withField + +```jsonnet +background.color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn background.color.withFixed + +```jsonnet +background.color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj background.image + + +##### fn background.image.withField + +```jsonnet +background.image.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn background.image.withFixed + +```jsonnet +background.image.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn background.image.withMode + +```jsonnet +background.image.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"mapping"` + + +### obj border + + +#### fn border.withColor + +```jsonnet +border.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn border.withColorMixin + +```jsonnet +border.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn border.withWidth + +```jsonnet +border.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj border.color + + +##### fn border.color.withField + +```jsonnet +border.color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn border.color.withFixed + +```jsonnet +border.color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj constraint + + +#### fn constraint.withHorizontal + +```jsonnet +constraint.withHorizontal(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"left"`, `"right"`, `"leftright"`, `"center"`, `"scale"` + + +#### fn constraint.withVertical + +```jsonnet +constraint.withVertical(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"top"`, `"bottom"`, `"topbottom"`, `"center"`, `"scale"` + + +### obj placement + + +#### fn placement.withBottom + +```jsonnet +placement.withBottom(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withHeight + +```jsonnet +placement.withHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withLeft + +```jsonnet +placement.withLeft(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withRight + +```jsonnet +placement.withRight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withTop + +```jsonnet +placement.withTop(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withWidth + +```jsonnet +placement.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/canvas/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/index.md new file mode 100644 index 0000000..a513921 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/index.md @@ -0,0 +1,761 @@ +# dashboardList + +grafonnet.panel.dashboardList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withFolderId(value)`](#fn-optionswithfolderid) + * [`fn withFolderUID(value)`](#fn-optionswithfolderuid) + * [`fn withIncludeVars(value=true)`](#fn-optionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-optionswithkeeptime) + * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) + * [`fn withQuery(value="")`](#fn-optionswithquery) + * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) + * [`fn withShowRecentlyViewed(value=true)`](#fn-optionswithshowrecentlyviewed) + * [`fn withShowSearch(value=true)`](#fn-optionswithshowsearch) + * [`fn withShowStarred(value=true)`](#fn-optionswithshowstarred) + * [`fn withTags(value)`](#fn-optionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new dashboardList panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withFolderId + +```jsonnet +options.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +folderId is deprecated, and migrated to folderUid on panel init +#### fn options.withFolderUID + +```jsonnet +options.withFolderUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn options.withIncludeVars + +```jsonnet +options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withKeepTime + +```jsonnet +options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withMaxItems + +```jsonnet +options.withMaxItems(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withQuery + +```jsonnet +options.withQuery(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +#### fn options.withShowHeadings + +```jsonnet +options.withShowHeadings(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowRecentlyViewed + +```jsonnet +options.withShowRecentlyViewed(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowSearch + +```jsonnet +options.withShowSearch(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowStarred + +```jsonnet +options.withShowStarred(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withTags + +```jsonnet +options.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTagsMixin + +```jsonnet +options.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/dashboardList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/index.md new file mode 100644 index 0000000..85b3408 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/index.md @@ -0,0 +1,622 @@ +# datagrid + +grafonnet.panel.datagrid + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withSelectedSeries(value=0)`](#fn-optionswithselectedseries) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new datagrid panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withSelectedSeries + +```jsonnet +options.withSelectedSeries(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/datagrid/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/index.md new file mode 100644 index 0000000..25d472c --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/index.md @@ -0,0 +1,689 @@ +# debug + +grafonnet.panel.debug + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCounters(value)`](#fn-optionswithcounters) + * [`fn withCountersMixin(value)`](#fn-optionswithcountersmixin) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`obj counters`](#obj-optionscounters) + * [`fn withDataChanged(value=true)`](#fn-optionscounterswithdatachanged) + * [`fn withRender(value=true)`](#fn-optionscounterswithrender) + * [`fn withSchemaChanged(value=true)`](#fn-optionscounterswithschemachanged) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new debug panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCounters + +```jsonnet +options.withCounters(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCountersMixin + +```jsonnet +options.withCountersMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"render"`, `"events"`, `"cursor"`, `"State"`, `"ThrowError"` + + +#### obj options.counters + + +##### fn options.counters.withDataChanged + +```jsonnet +options.counters.withDataChanged(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.counters.withRender + +```jsonnet +options.counters.withRender(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.counters.withSchemaChanged + +```jsonnet +options.counters.withSchemaChanged(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/debug/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/index.md new file mode 100644 index 0000000..16a32da --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/index.md @@ -0,0 +1,815 @@ +# gauge + +grafonnet.panel.gauge + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withMinVizHeight(value=75)`](#fn-optionswithminvizheight) + * [`fn withMinVizWidth(value=75)`](#fn-optionswithminvizwidth) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowThresholdLabels(value=true)`](#fn-optionswithshowthresholdlabels) + * [`fn withShowThresholdMarkers(value=true)`](#fn-optionswithshowthresholdmarkers) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new gauge panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withMinVizHeight + +```jsonnet +options.withMinVizHeight(value=75) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `75` + + +#### fn options.withMinVizWidth + +```jsonnet +options.withMinVizWidth(value=75) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `75` + + +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowThresholdLabels + +```jsonnet +options.withShowThresholdLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowThresholdMarkers + +```jsonnet +options.withShowThresholdMarkers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/gauge/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/index.md new file mode 100644 index 0000000..27afea9 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/index.md @@ -0,0 +1,1164 @@ +# geomap + +grafonnet.panel.geomap + +## Subpackages + +* [options.layers](options/layers.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBasemap(value)`](#fn-optionswithbasemap) + * [`fn withBasemapMixin(value)`](#fn-optionswithbasemapmixin) + * [`fn withControls(value)`](#fn-optionswithcontrols) + * [`fn withControlsMixin(value)`](#fn-optionswithcontrolsmixin) + * [`fn withLayers(value)`](#fn-optionswithlayers) + * [`fn withLayersMixin(value)`](#fn-optionswithlayersmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withView(value)`](#fn-optionswithview) + * [`fn withViewMixin(value)`](#fn-optionswithviewmixin) + * [`obj basemap`](#obj-optionsbasemap) + * [`fn withConfig(value)`](#fn-optionsbasemapwithconfig) + * [`fn withFilterData(value)`](#fn-optionsbasemapwithfilterdata) + * [`fn withLocation(value)`](#fn-optionsbasemapwithlocation) + * [`fn withLocationMixin(value)`](#fn-optionsbasemapwithlocationmixin) + * [`fn withName(value)`](#fn-optionsbasemapwithname) + * [`fn withOpacity(value)`](#fn-optionsbasemapwithopacity) + * [`fn withTooltip(value=true)`](#fn-optionsbasemapwithtooltip) + * [`fn withType(value)`](#fn-optionsbasemapwithtype) + * [`obj location`](#obj-optionsbasemaplocation) + * [`fn withGazetteer(value)`](#fn-optionsbasemaplocationwithgazetteer) + * [`fn withGeohash(value)`](#fn-optionsbasemaplocationwithgeohash) + * [`fn withLatitude(value)`](#fn-optionsbasemaplocationwithlatitude) + * [`fn withLongitude(value)`](#fn-optionsbasemaplocationwithlongitude) + * [`fn withLookup(value)`](#fn-optionsbasemaplocationwithlookup) + * [`fn withMode(value)`](#fn-optionsbasemaplocationwithmode) + * [`fn withWkt(value)`](#fn-optionsbasemaplocationwithwkt) + * [`obj controls`](#obj-optionscontrols) + * [`fn withMouseWheelZoom(value=true)`](#fn-optionscontrolswithmousewheelzoom) + * [`fn withShowAttribution(value=true)`](#fn-optionscontrolswithshowattribution) + * [`fn withShowDebug(value=true)`](#fn-optionscontrolswithshowdebug) + * [`fn withShowMeasure(value=true)`](#fn-optionscontrolswithshowmeasure) + * [`fn withShowScale(value=true)`](#fn-optionscontrolswithshowscale) + * [`fn withShowZoom(value=true)`](#fn-optionscontrolswithshowzoom) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`obj view`](#obj-optionsview) + * [`fn withAllLayers(value=true)`](#fn-optionsviewwithalllayers) + * [`fn withId(value="zero")`](#fn-optionsviewwithid) + * [`fn withLastOnly(value=true)`](#fn-optionsviewwithlastonly) + * [`fn withLat(value=0)`](#fn-optionsviewwithlat) + * [`fn withLayer(value)`](#fn-optionsviewwithlayer) + * [`fn withLon(value=0)`](#fn-optionsviewwithlon) + * [`fn withMaxZoom(value)`](#fn-optionsviewwithmaxzoom) + * [`fn withMinZoom(value)`](#fn-optionsviewwithminzoom) + * [`fn withPadding(value)`](#fn-optionsviewwithpadding) + * [`fn withShared(value=true)`](#fn-optionsviewwithshared) + * [`fn withZoom(value=1)`](#fn-optionsviewwithzoom) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new geomap panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBasemap + +```jsonnet +options.withBasemap(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withBasemapMixin + +```jsonnet +options.withBasemapMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withControls + +```jsonnet +options.withControls(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withControlsMixin + +```jsonnet +options.withControlsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLayers + +```jsonnet +options.withLayers(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withLayersMixin + +```jsonnet +options.withLayersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withView + +```jsonnet +options.withView(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withViewMixin + +```jsonnet +options.withViewMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.basemap + + +##### fn options.basemap.withConfig + +```jsonnet +options.basemap.withConfig(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Custom options depending on the type +##### fn options.basemap.withFilterData + +```jsonnet +options.basemap.withFilterData(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Defines a frame MatcherConfig that may filter data for the given layer +##### fn options.basemap.withLocation + +```jsonnet +options.basemap.withLocation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.basemap.withLocationMixin + +```jsonnet +options.basemap.withLocationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.basemap.withName + +```jsonnet +options.basemap.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +configured unique display name +##### fn options.basemap.withOpacity + +```jsonnet +options.basemap.withOpacity(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Common properties: +https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html +Layer opacity (0-1) +##### fn options.basemap.withTooltip + +```jsonnet +options.basemap.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Check tooltip (defaults to true) +##### fn options.basemap.withType + +```jsonnet +options.basemap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.basemap.location + + +###### fn options.basemap.location.withGazetteer + +```jsonnet +options.basemap.location.withGazetteer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Path to Gazetteer +###### fn options.basemap.location.withGeohash + +```jsonnet +options.basemap.location.withGeohash(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field mappings +###### fn options.basemap.location.withLatitude + +```jsonnet +options.basemap.location.withLatitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withLongitude + +```jsonnet +options.basemap.location.withLongitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withLookup + +```jsonnet +options.basemap.location.withLookup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withMode + +```jsonnet +options.basemap.location.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"geohash"`, `"coords"`, `"lookup"` + + +###### fn options.basemap.location.withWkt + +```jsonnet +options.basemap.location.withWkt(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj options.controls + + +##### fn options.controls.withMouseWheelZoom + +```jsonnet +options.controls.withMouseWheelZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +let the mouse wheel zoom +##### fn options.controls.withShowAttribution + +```jsonnet +options.controls.withShowAttribution(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Lower right +##### fn options.controls.withShowDebug + +```jsonnet +options.controls.withShowDebug(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show debug +##### fn options.controls.withShowMeasure + +```jsonnet +options.controls.withShowMeasure(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show measure +##### fn options.controls.withShowScale + +```jsonnet +options.controls.withShowScale(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Scale options +##### fn options.controls.withShowZoom + +```jsonnet +options.controls.withShowZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Zoom (upper left) +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"details"` + + +#### obj options.view + + +##### fn options.view.withAllLayers + +```jsonnet +options.view.withAllLayers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withId + +```jsonnet +options.view.withId(value="zero") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"zero"` + + +##### fn options.view.withLastOnly + +```jsonnet +options.view.withLastOnly(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withLat + +```jsonnet +options.view.withLat(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +##### fn options.view.withLayer + +```jsonnet +options.view.withLayer(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.view.withLon + +```jsonnet +options.view.withLon(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +##### fn options.view.withMaxZoom + +```jsonnet +options.view.withMaxZoom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withMinZoom + +```jsonnet +options.view.withMinZoom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withPadding + +```jsonnet +options.view.withPadding(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withShared + +```jsonnet +options.view.withShared(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withZoom + +```jsonnet +options.view.withZoom(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/options/layers.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/options/layers.md new file mode 100644 index 0000000..d65f7c6 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/options/layers.md @@ -0,0 +1,196 @@ +# layers + + + +## Index + +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withFilterData(value)`](#fn-withfilterdata) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withLocationMixin(value)`](#fn-withlocationmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withOpacity(value)`](#fn-withopacity) +* [`fn withTooltip(value=true)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`obj location`](#obj-location) + * [`fn withGazetteer(value)`](#fn-locationwithgazetteer) + * [`fn withGeohash(value)`](#fn-locationwithgeohash) + * [`fn withLatitude(value)`](#fn-locationwithlatitude) + * [`fn withLongitude(value)`](#fn-locationwithlongitude) + * [`fn withLookup(value)`](#fn-locationwithlookup) + * [`fn withMode(value)`](#fn-locationwithmode) + * [`fn withWkt(value)`](#fn-locationwithwkt) + +## Fields + +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Custom options depending on the type +### fn withFilterData + +```jsonnet +withFilterData(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Defines a frame MatcherConfig that may filter data for the given layer +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLocationMixin + +```jsonnet +withLocationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +configured unique display name +### fn withOpacity + +```jsonnet +withOpacity(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Common properties: +https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html +Layer opacity (0-1) +### fn withTooltip + +```jsonnet +withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Check tooltip (defaults to true) +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj location + + +#### fn location.withGazetteer + +```jsonnet +location.withGazetteer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Path to Gazetteer +#### fn location.withGeohash + +```jsonnet +location.withGeohash(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field mappings +#### fn location.withLatitude + +```jsonnet +location.withLatitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withLongitude + +```jsonnet +location.withLongitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withLookup + +```jsonnet +location.withLookup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withMode + +```jsonnet +location.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"geohash"`, `"coords"`, `"lookup"` + + +#### fn location.withWkt + +```jsonnet +location.withWkt(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/geomap/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/index.md new file mode 100644 index 0000000..977f288 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/index.md @@ -0,0 +1,1858 @@ +# heatmap + +grafonnet.panel.heatmap + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCalculate(value=true)`](#fn-optionswithcalculate) + * [`fn withCalculation(value)`](#fn-optionswithcalculation) + * [`fn withCalculationMixin(value)`](#fn-optionswithcalculationmixin) + * [`fn withCellGap(value=1)`](#fn-optionswithcellgap) + * [`fn withCellRadius(value)`](#fn-optionswithcellradius) + * [`fn withCellValues(value={})`](#fn-optionswithcellvalues) + * [`fn withCellValuesMixin(value={})`](#fn-optionswithcellvaluesmixin) + * [`fn withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolor) + * [`fn withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolormixin) + * [`fn withExemplars(value)`](#fn-optionswithexemplars) + * [`fn withExemplarsMixin(value)`](#fn-optionswithexemplarsmixin) + * [`fn withFilterValues(value={"le": 0.000000001})`](#fn-optionswithfiltervalues) + * [`fn withFilterValuesMixin(value={"le": 0.000000001})`](#fn-optionswithfiltervaluesmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withRowsFrame(value)`](#fn-optionswithrowsframe) + * [`fn withRowsFrameMixin(value)`](#fn-optionswithrowsframemixin) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withYAxis(value)`](#fn-optionswithyaxis) + * [`fn withYAxisMixin(value)`](#fn-optionswithyaxismixin) + * [`obj calculation`](#obj-optionscalculation) + * [`fn withXBuckets(value)`](#fn-optionscalculationwithxbuckets) + * [`fn withXBucketsMixin(value)`](#fn-optionscalculationwithxbucketsmixin) + * [`fn withYBuckets(value)`](#fn-optionscalculationwithybuckets) + * [`fn withYBucketsMixin(value)`](#fn-optionscalculationwithybucketsmixin) + * [`obj xBuckets`](#obj-optionscalculationxbuckets) + * [`fn withMode(value)`](#fn-optionscalculationxbucketswithmode) + * [`fn withScale(value)`](#fn-optionscalculationxbucketswithscale) + * [`fn withScaleMixin(value)`](#fn-optionscalculationxbucketswithscalemixin) + * [`fn withValue(value)`](#fn-optionscalculationxbucketswithvalue) + * [`obj scale`](#obj-optionscalculationxbucketsscale) + * [`fn withLinearThreshold(value)`](#fn-optionscalculationxbucketsscalewithlinearthreshold) + * [`fn withLog(value)`](#fn-optionscalculationxbucketsscalewithlog) + * [`fn withType(value)`](#fn-optionscalculationxbucketsscalewithtype) + * [`obj yBuckets`](#obj-optionscalculationybuckets) + * [`fn withMode(value)`](#fn-optionscalculationybucketswithmode) + * [`fn withScale(value)`](#fn-optionscalculationybucketswithscale) + * [`fn withScaleMixin(value)`](#fn-optionscalculationybucketswithscalemixin) + * [`fn withValue(value)`](#fn-optionscalculationybucketswithvalue) + * [`obj scale`](#obj-optionscalculationybucketsscale) + * [`fn withLinearThreshold(value)`](#fn-optionscalculationybucketsscalewithlinearthreshold) + * [`fn withLog(value)`](#fn-optionscalculationybucketsscalewithlog) + * [`fn withType(value)`](#fn-optionscalculationybucketsscalewithtype) + * [`obj cellValues`](#obj-optionscellvalues) + * [`fn withCellValues(value)`](#fn-optionscellvalueswithcellvalues) + * [`fn withCellValuesMixin(value)`](#fn-optionscellvalueswithcellvaluesmixin) + * [`obj CellValues`](#obj-optionscellvaluescellvalues) + * [`fn withDecimals(value)`](#fn-optionscellvaluescellvalueswithdecimals) + * [`fn withUnit(value)`](#fn-optionscellvaluescellvalueswithunit) + * [`obj color`](#obj-optionscolor) + * [`fn withHeatmapColorOptions(value)`](#fn-optionscolorwithheatmapcoloroptions) + * [`fn withHeatmapColorOptionsMixin(value)`](#fn-optionscolorwithheatmapcoloroptionsmixin) + * [`obj HeatmapColorOptions`](#obj-optionscolorheatmapcoloroptions) + * [`fn withExponent(value)`](#fn-optionscolorheatmapcoloroptionswithexponent) + * [`fn withFill(value)`](#fn-optionscolorheatmapcoloroptionswithfill) + * [`fn withMax(value)`](#fn-optionscolorheatmapcoloroptionswithmax) + * [`fn withMin(value)`](#fn-optionscolorheatmapcoloroptionswithmin) + * [`fn withMode(value)`](#fn-optionscolorheatmapcoloroptionswithmode) + * [`fn withReverse(value=true)`](#fn-optionscolorheatmapcoloroptionswithreverse) + * [`fn withScale(value)`](#fn-optionscolorheatmapcoloroptionswithscale) + * [`fn withScheme(value)`](#fn-optionscolorheatmapcoloroptionswithscheme) + * [`fn withSteps(value)`](#fn-optionscolorheatmapcoloroptionswithsteps) + * [`obj exemplars`](#obj-optionsexemplars) + * [`fn withColor(value)`](#fn-optionsexemplarswithcolor) + * [`obj filterValues`](#obj-optionsfiltervalues) + * [`fn withFilterValueRange(value)`](#fn-optionsfiltervalueswithfiltervaluerange) + * [`fn withFilterValueRangeMixin(value)`](#fn-optionsfiltervalueswithfiltervaluerangemixin) + * [`obj FilterValueRange`](#obj-optionsfiltervaluesfiltervaluerange) + * [`fn withGe(value)`](#fn-optionsfiltervaluesfiltervaluerangewithge) + * [`fn withLe(value)`](#fn-optionsfiltervaluesfiltervaluerangewithle) + * [`obj legend`](#obj-optionslegend) + * [`fn withShow(value=true)`](#fn-optionslegendwithshow) + * [`obj rowsFrame`](#obj-optionsrowsframe) + * [`fn withLayout(value)`](#fn-optionsrowsframewithlayout) + * [`fn withValue(value)`](#fn-optionsrowsframewithvalue) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withShow(value=true)`](#fn-optionstooltipwithshow) + * [`fn withYHistogram(value=true)`](#fn-optionstooltipwithyhistogram) + * [`obj yAxis`](#obj-optionsyaxis) + * [`fn withAxisBorderShow(value=true)`](#fn-optionsyaxiswithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-optionsyaxiswithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-optionsyaxiswithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-optionsyaxiswithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-optionsyaxiswithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-optionsyaxiswithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-optionsyaxiswithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-optionsyaxiswithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-optionsyaxiswithaxiswidth) + * [`fn withDecimals(value)`](#fn-optionsyaxiswithdecimals) + * [`fn withMax(value)`](#fn-optionsyaxiswithmax) + * [`fn withMin(value)`](#fn-optionsyaxiswithmin) + * [`fn withReverse(value=true)`](#fn-optionsyaxiswithreverse) + * [`fn withScaleDistribution(value)`](#fn-optionsyaxiswithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-optionsyaxiswithscaledistributionmixin) + * [`fn withUnit(value)`](#fn-optionsyaxiswithunit) + * [`obj scaleDistribution`](#obj-optionsyaxisscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-optionsyaxisscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-optionsyaxisscaledistributionwithlog) + * [`fn withType(value)`](#fn-optionsyaxisscaledistributionwithtype) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new heatmap panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCalculate + +```jsonnet +options.withCalculate(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the heatmap should be calculated from data +#### fn options.withCalculation + +```jsonnet +options.withCalculation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCalculationMixin + +```jsonnet +options.withCalculationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCellGap + +```jsonnet +options.withCellGap(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls gap between cells +#### fn options.withCellRadius + +```jsonnet +options.withCellRadius(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls cell radius +#### fn options.withCellValues + +```jsonnet +options.withCellValues(value={}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{}` + +Controls cell value unit +#### fn options.withCellValuesMixin + +```jsonnet +options.withCellValuesMixin(value={}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{}` + +Controls cell value unit +#### fn options.withColor + +```jsonnet +options.withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}` + +Controls the color options +#### fn options.withColorMixin + +```jsonnet +options.withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}` + +Controls the color options +#### fn options.withExemplars + +```jsonnet +options.withExemplars(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls exemplar options +#### fn options.withExemplarsMixin + +```jsonnet +options.withExemplarsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls exemplar options +#### fn options.withFilterValues + +```jsonnet +options.withFilterValues(value={"le": 0.000000001}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"le": 0.000000001}` + +Filters values between a given range +#### fn options.withFilterValuesMixin + +```jsonnet +options.withFilterValuesMixin(value={"le": 0.000000001}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"le": 0.000000001}` + +Filters values between a given range +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls legend options +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls legend options +#### fn options.withRowsFrame + +```jsonnet +options.withRowsFrame(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls frame rows options +#### fn options.withRowsFrameMixin + +```jsonnet +options.withRowsFrameMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls frame rows options +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +| *{ + layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed +} +Controls the display of the value in the cell +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls tooltip options +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls tooltip options +#### fn options.withYAxis + +```jsonnet +options.withYAxis(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration options for the yAxis +#### fn options.withYAxisMixin + +```jsonnet +options.withYAxisMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration options for the yAxis +#### obj options.calculation + + +##### fn options.calculation.withXBuckets + +```jsonnet +options.calculation.withXBuckets(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withXBucketsMixin + +```jsonnet +options.calculation.withXBucketsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withYBuckets + +```jsonnet +options.calculation.withYBuckets(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withYBucketsMixin + +```jsonnet +options.calculation.withYBucketsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### obj options.calculation.xBuckets + + +###### fn options.calculation.xBuckets.withMode + +```jsonnet +options.calculation.xBuckets.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"size"`, `"count"` + + +###### fn options.calculation.xBuckets.withScale + +```jsonnet +options.calculation.xBuckets.withScale(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.xBuckets.withScaleMixin + +```jsonnet +options.calculation.xBuckets.withScaleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.xBuckets.withValue + +```jsonnet +options.calculation.xBuckets.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The number of buckets to use for the axis in the heatmap +###### obj options.calculation.xBuckets.scale + + +####### fn options.calculation.xBuckets.scale.withLinearThreshold + +```jsonnet +options.calculation.xBuckets.scale.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.xBuckets.scale.withLog + +```jsonnet +options.calculation.xBuckets.scale.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.xBuckets.scale.withType + +```jsonnet +options.calculation.xBuckets.scale.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +##### obj options.calculation.yBuckets + + +###### fn options.calculation.yBuckets.withMode + +```jsonnet +options.calculation.yBuckets.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"size"`, `"count"` + + +###### fn options.calculation.yBuckets.withScale + +```jsonnet +options.calculation.yBuckets.withScale(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.yBuckets.withScaleMixin + +```jsonnet +options.calculation.yBuckets.withScaleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.yBuckets.withValue + +```jsonnet +options.calculation.yBuckets.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The number of buckets to use for the axis in the heatmap +###### obj options.calculation.yBuckets.scale + + +####### fn options.calculation.yBuckets.scale.withLinearThreshold + +```jsonnet +options.calculation.yBuckets.scale.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.yBuckets.scale.withLog + +```jsonnet +options.calculation.yBuckets.scale.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.yBuckets.scale.withType + +```jsonnet +options.calculation.yBuckets.scale.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +#### obj options.cellValues + + +##### fn options.cellValues.withCellValues + +```jsonnet +options.cellValues.withCellValues(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls cell value options +##### fn options.cellValues.withCellValuesMixin + +```jsonnet +options.cellValues.withCellValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls cell value options +##### obj options.cellValues.CellValues + + +###### fn options.cellValues.CellValues.withDecimals + +```jsonnet +options.cellValues.CellValues.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the number of decimals for cell values +###### fn options.cellValues.CellValues.withUnit + +```jsonnet +options.cellValues.CellValues.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the cell value unit +#### obj options.color + + +##### fn options.color.withHeatmapColorOptions + +```jsonnet +options.color.withHeatmapColorOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls various color options +##### fn options.color.withHeatmapColorOptionsMixin + +```jsonnet +options.color.withHeatmapColorOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls various color options +##### obj options.color.HeatmapColorOptions + + +###### fn options.color.HeatmapColorOptions.withExponent + +```jsonnet +options.color.HeatmapColorOptions.withExponent(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the exponent when scale is set to exponential +###### fn options.color.HeatmapColorOptions.withFill + +```jsonnet +options.color.HeatmapColorOptions.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the color fill when in opacity mode +###### fn options.color.HeatmapColorOptions.withMax + +```jsonnet +options.color.HeatmapColorOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the maximum value for the color scale +###### fn options.color.HeatmapColorOptions.withMin + +```jsonnet +options.color.HeatmapColorOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the minimum value for the color scale +###### fn options.color.HeatmapColorOptions.withMode + +```jsonnet +options.color.HeatmapColorOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"opacity"`, `"scheme"` + +Controls the color mode of the heatmap +###### fn options.color.HeatmapColorOptions.withReverse + +```jsonnet +options.color.HeatmapColorOptions.withReverse(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Reverses the color scheme +###### fn options.color.HeatmapColorOptions.withScale + +```jsonnet +options.color.HeatmapColorOptions.withScale(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"exponential"` + +Controls the color scale of the heatmap +###### fn options.color.HeatmapColorOptions.withScheme + +```jsonnet +options.color.HeatmapColorOptions.withScheme(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the color scheme used +###### fn options.color.HeatmapColorOptions.withSteps + +```jsonnet +options.color.HeatmapColorOptions.withSteps(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Controls the number of color steps +#### obj options.exemplars + + +##### fn options.exemplars.withColor + +```jsonnet +options.exemplars.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the color of the exemplar markers +#### obj options.filterValues + + +##### fn options.filterValues.withFilterValueRange + +```jsonnet +options.filterValues.withFilterValueRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls the value filter range +##### fn options.filterValues.withFilterValueRangeMixin + +```jsonnet +options.filterValues.withFilterValueRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls the value filter range +##### obj options.filterValues.FilterValueRange + + +###### fn options.filterValues.FilterValueRange.withGe + +```jsonnet +options.filterValues.FilterValueRange.withGe(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the filter range to values greater than or equal to the given value +###### fn options.filterValues.FilterValueRange.withLe + +```jsonnet +options.filterValues.FilterValueRange.withLe(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the filter range to values less than or equal to the given value +#### obj options.legend + + +##### fn options.legend.withShow + +```jsonnet +options.legend.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the legend is shown +#### obj options.rowsFrame + + +##### fn options.rowsFrame.withLayout + +```jsonnet +options.rowsFrame.withLayout(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"le"`, `"ge"`, `"unknown"`, `"auto"` + + +##### fn options.rowsFrame.withValue + +```jsonnet +options.rowsFrame.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the name of the cell when not calculating from data +#### obj options.tooltip + + +##### fn options.tooltip.withShow + +```jsonnet +options.tooltip.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the tooltip is shown +##### fn options.tooltip.withYHistogram + +```jsonnet +options.tooltip.withYHistogram(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the tooltip shows a histogram of the y-axis values +#### obj options.yAxis + + +##### fn options.yAxis.withAxisBorderShow + +```jsonnet +options.yAxis.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisCenteredZero + +```jsonnet +options.yAxis.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisColorMode + +```jsonnet +options.yAxis.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +##### fn options.yAxis.withAxisGridShow + +```jsonnet +options.yAxis.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisLabel + +```jsonnet +options.yAxis.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.yAxis.withAxisPlacement + +```jsonnet +options.yAxis.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +##### fn options.yAxis.withAxisSoftMax + +```jsonnet +options.yAxis.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withAxisSoftMin + +```jsonnet +options.yAxis.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withAxisWidth + +```jsonnet +options.yAxis.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withDecimals + +```jsonnet +options.yAxis.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the number of decimals for yAxis values +##### fn options.yAxis.withMax + +```jsonnet +options.yAxis.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the maximum value for the yAxis +##### fn options.yAxis.withMin + +```jsonnet +options.yAxis.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the minimum value for the yAxis +##### fn options.yAxis.withReverse + +```jsonnet +options.yAxis.withReverse(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Reverses the yAxis +##### fn options.yAxis.withScaleDistribution + +```jsonnet +options.yAxis.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +##### fn options.yAxis.withScaleDistributionMixin + +```jsonnet +options.yAxis.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +##### fn options.yAxis.withUnit + +```jsonnet +options.yAxis.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the yAxis unit +##### obj options.yAxis.scaleDistribution + + +###### fn options.yAxis.scaleDistribution.withLinearThreshold + +```jsonnet +options.yAxis.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.yAxis.scaleDistribution.withLog + +```jsonnet +options.yAxis.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.yAxis.scaleDistribution.withType + +```jsonnet +options.yAxis.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/heatmap/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/index.md new file mode 100644 index 0000000..2407d23 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/index.md @@ -0,0 +1,1152 @@ +# histogram + +grafonnet.panel.histogram + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBucketOffset(value=0)`](#fn-optionswithbucketoffset) + * [`fn withBucketSize(value)`](#fn-optionswithbucketsize) + * [`fn withCombine(value=true)`](#fn-optionswithcombine) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new histogram panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=80) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `80` + +Controls the fill opacity of the bars. +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. +Gradient appearance is influenced by the Fill opacity setting. +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls line width of the bars. +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBucketOffset + +```jsonnet +options.withBucketOffset(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Offset buckets by this amount +#### fn options.withBucketSize + +```jsonnet +options.withBucketSize(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Size of each bucket +#### fn options.withCombine + +```jsonnet +options.withCombine(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Combines multiple series into a single histogram +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/histogram/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/index.md similarity index 96% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/index.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/index.md index be9bac0..d29f157 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/index.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/index.md @@ -5,6 +5,7 @@ grafonnet.panel ## Subpackages * [alertGroups](alertGroups/index.md) +* [alertList](alertList/index.md) * [annotationsList](annotationsList/index.md) * [barChart](barChart/index.md) * [barGauge](barGauge/index.md) @@ -30,4 +31,3 @@ grafonnet.panel * [timeSeries](timeSeries/index.md) * [trend](trend/index.md) * [xyChart](xyChart/index.md) - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/index.md new file mode 100644 index 0000000..1063024 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/index.md @@ -0,0 +1,713 @@ +# logs + +grafonnet.panel.logs + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDedupStrategy(value)`](#fn-optionswithdedupstrategy) + * [`fn withEnableLogDetails(value=true)`](#fn-optionswithenablelogdetails) + * [`fn withPrettifyLogMessage(value=true)`](#fn-optionswithprettifylogmessage) + * [`fn withShowCommonLabels(value=true)`](#fn-optionswithshowcommonlabels) + * [`fn withShowLabels(value=true)`](#fn-optionswithshowlabels) + * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) + * [`fn withSortOrder(value)`](#fn-optionswithsortorder) + * [`fn withWrapLogMessage(value=true)`](#fn-optionswithwraplogmessage) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new logs panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDedupStrategy + +```jsonnet +options.withDedupStrategy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"exact"`, `"numbers"`, `"signature"` + + +#### fn options.withEnableLogDetails + +```jsonnet +options.withEnableLogDetails(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withPrettifyLogMessage + +```jsonnet +options.withPrettifyLogMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowCommonLabels + +```jsonnet +options.withShowCommonLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowLabels + +```jsonnet +options.withShowLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTime + +```jsonnet +options.withShowTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSortOrder + +```jsonnet +options.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Descending"`, `"Ascending"` + + +#### fn options.withWrapLogMessage + +```jsonnet +options.withWrapLogMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/logs/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/index.md new file mode 100644 index 0000000..3790c6e --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/index.md @@ -0,0 +1,634 @@ +# news + +grafonnet.panel.news + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withFeedUrl(value)`](#fn-optionswithfeedurl) + * [`fn withShowImage(value=true)`](#fn-optionswithshowimage) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new news panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withFeedUrl + +```jsonnet +options.withFeedUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +empty/missing will default to grafana blog +#### fn options.withShowImage + +```jsonnet +options.withShowImage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/news/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/index.md new file mode 100644 index 0000000..c9ed6b6 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/index.md @@ -0,0 +1,738 @@ +# nodeGraph + +grafonnet.panel.nodeGraph + +## Subpackages + +* [options.nodes.arcs](options/nodes/arcs.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withEdges(value)`](#fn-optionswithedges) + * [`fn withEdgesMixin(value)`](#fn-optionswithedgesmixin) + * [`fn withNodes(value)`](#fn-optionswithnodes) + * [`fn withNodesMixin(value)`](#fn-optionswithnodesmixin) + * [`obj edges`](#obj-optionsedges) + * [`fn withMainStatUnit(value)`](#fn-optionsedgeswithmainstatunit) + * [`fn withSecondaryStatUnit(value)`](#fn-optionsedgeswithsecondarystatunit) + * [`obj nodes`](#obj-optionsnodes) + * [`fn withArcs(value)`](#fn-optionsnodeswitharcs) + * [`fn withArcsMixin(value)`](#fn-optionsnodeswitharcsmixin) + * [`fn withMainStatUnit(value)`](#fn-optionsnodeswithmainstatunit) + * [`fn withSecondaryStatUnit(value)`](#fn-optionsnodeswithsecondarystatunit) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new nodeGraph panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withEdges + +```jsonnet +options.withEdges(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withEdgesMixin + +```jsonnet +options.withEdgesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withNodes + +```jsonnet +options.withNodes(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withNodesMixin + +```jsonnet +options.withNodesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.edges + + +##### fn options.edges.withMainStatUnit + +```jsonnet +options.edges.withMainStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the main stat to override what ever is set in the data frame. +##### fn options.edges.withSecondaryStatUnit + +```jsonnet +options.edges.withSecondaryStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the secondary stat to override what ever is set in the data frame. +#### obj options.nodes + + +##### fn options.nodes.withArcs + +```jsonnet +options.nodes.withArcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Define which fields are shown as part of the node arc (colored circle around the node). +##### fn options.nodes.withArcsMixin + +```jsonnet +options.nodes.withArcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Define which fields are shown as part of the node arc (colored circle around the node). +##### fn options.nodes.withMainStatUnit + +```jsonnet +options.nodes.withMainStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the main stat to override what ever is set in the data frame. +##### fn options.nodes.withSecondaryStatUnit + +```jsonnet +options.nodes.withSecondaryStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the secondary stat to override what ever is set in the data frame. +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/options/nodes/arcs.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/options/nodes/arcs.md new file mode 100644 index 0000000..f80fe24 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/options/nodes/arcs.md @@ -0,0 +1,33 @@ +# arcs + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withField(value)`](#fn-withfield) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The color of the arc. +### fn withField + +```jsonnet +withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field from which to get the value. Values should be less than 1, representing fraction of a circle. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/nodeGraph/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/index.md new file mode 100644 index 0000000..4bf537f --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/index.md @@ -0,0 +1,1112 @@ +# pieChart + +grafonnet.panel.pieChart + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDisplayLabels(value)`](#fn-optionswithdisplaylabels) + * [`fn withDisplayLabelsMixin(value)`](#fn-optionswithdisplaylabelsmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withPieType(value)`](#fn-optionswithpietype) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withValues(value)`](#fn-optionslegendwithvalues) + * [`fn withValuesMixin(value)`](#fn-optionslegendwithvaluesmixin) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new pieChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDisplayLabels + +```jsonnet +options.withDisplayLabels(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withDisplayLabelsMixin + +```jsonnet +options.withDisplayLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withPieType + +```jsonnet +options.withPieType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"pie"`, `"donut"` + +Select the pie chart display style. +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withValues + +```jsonnet +options.legend.withValues(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withValuesMixin + +```jsonnet +options.legend.withValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/pieChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/row.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/row.md similarity index 51% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/row.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/row.md index d19255f..0541b04 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/row.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/row.md @@ -5,10 +5,10 @@ grafonnet.panel.row ## Index * [`fn new(title)`](#fn-new) -* [`fn withCollapsed(value=false)`](#fn-withcollapsed) +* [`fn withCollapsed(value=true)`](#fn-withcollapsed) * [`fn withDatasource(value)`](#fn-withdatasource) * [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) -* [`fn withGridPos(value)`](#fn-withgridpos) +* [`fn withGridPos(y)`](#fn-withgridpos) * [`fn withGridPosMixin(value)`](#fn-withgridposmixin) * [`fn withId(value)`](#fn-withid) * [`fn withPanels(value)`](#fn-withpanels) @@ -19,106 +19,134 @@ grafonnet.panel.row * [`obj datasource`](#obj-datasource) * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) ## Fields ### fn new -```ts +```jsonnet new(title) ``` -Creates a new row panel with a title. +PARAMETERS: + +* **title** (`string`) +Creates a new row panel with a title. ### fn withCollapsed -```ts -withCollapsed(value=false) +```jsonnet +withCollapsed(value=true) ``` +PARAMETERS: +* **value** (`boolean`) + - default value: `true` +Whether this row should be collapsed or not. ### fn withDatasource -```ts +```jsonnet withDatasource(value) ``` -Name of default datasource. +PARAMETERS: + +* **value** (`object`) +Ref to a DataSource instance ### fn withDatasourceMixin -```ts +```jsonnet withDatasourceMixin(value) ``` -Name of default datasource. +PARAMETERS: +* **value** (`object`) + +Ref to a DataSource instance ### fn withGridPos -```ts -withGridPos(value) +```jsonnet +withGridPos(y) ``` +PARAMETERS: +* **y** (`number`) +`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values. ### fn withGridPosMixin -```ts +```jsonnet withGridPosMixin(value) ``` +PARAMETERS: +* **value** (`object`) +Position and dimensions of a panel in the grid ### fn withId -```ts +```jsonnet withId(value) ``` +PARAMETERS: +* **value** (`integer`) +Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. ### fn withPanels -```ts +```jsonnet withPanels(value) ``` +PARAMETERS: + +* **value** (`array`) ### fn withPanelsMixin -```ts +```jsonnet withPanelsMixin(value) ``` +PARAMETERS: + +* **value** (`array`) ### fn withRepeat -```ts +```jsonnet withRepeat(value) ``` -Name of template variable to repeat for. +PARAMETERS: +* **value** (`string`) + +Name of template variable to repeat for. ### fn withTitle -```ts +```jsonnet withTitle(value) ``` +PARAMETERS: +* **value** (`string`) +Row title ### fn withType -```ts +```jsonnet withType() ``` @@ -129,59 +157,23 @@ withType() #### fn datasource.withType -```ts -withType(value) +```jsonnet +datasource.withType(value) ``` +PARAMETERS: +* **value** (`string`) +The plugin type-id #### fn datasource.withUid -```ts -withUid(value) +```jsonnet +datasource.withUid(value) ``` +PARAMETERS: +* **value** (`string`) -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y +Specific datasource instance \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/index.md new file mode 100644 index 0000000..a4e2bc7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/index.md @@ -0,0 +1,815 @@ +# stat + +grafonnet.panel.stat + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withColorMode(value)`](#fn-optionswithcolormode) + * [`fn withGraphMode(value)`](#fn-optionswithgraphmode) + * [`fn withJustifyMode(value)`](#fn-optionswithjustifymode) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTextMode(value)`](#fn-optionswithtextmode) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new stat panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withColorMode + +```jsonnet +options.withColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"value"`, `"background"`, `"background_solid"`, `"none"` + +TODO docs +#### fn options.withGraphMode + +```jsonnet +options.withGraphMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"line"`, `"area"` + +TODO docs +#### fn options.withJustifyMode + +```jsonnet +options.withJustifyMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"center"` + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMode + +```jsonnet +options.withTextMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"value"`, `"value_and_name"`, `"name"`, `"none"` + +TODO docs +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stat/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/index.md new file mode 100644 index 0000000..58edfe2 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/index.md @@ -0,0 +1,997 @@ +# stateTimeline + +grafonnet.panel.stateTimeline + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=0)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlignValue(value)`](#fn-optionswithalignvalue) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMergeValues(value=true)`](#fn-optionswithmergevalues) + * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new stateTimeline panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=70) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `70` + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withAlignValue + +```jsonnet +options.withAlignValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls value alignment on the timelines +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMergeValues + +```jsonnet +options.withMergeValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Merge equal consecutive values +#### fn options.withRowHeight + +```jsonnet +options.withRowHeight(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Controls the row height +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Show timeline values on chart +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/stateTimeline/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/index.md new file mode 100644 index 0000000..837dd44 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/index.md @@ -0,0 +1,985 @@ +# statusHistory + +grafonnet.panel.statusHistory + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withColWidth(value=0.9)`](#fn-optionswithcolwidth) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new statusHistory panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=70) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `70` + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withColWidth + +```jsonnet +options.withColWidth(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Controls the column width +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withRowHeight + +```jsonnet +options.withRowHeight(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Set the height of the rows +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Show values on the columns +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/statusHistory/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/index.md new file mode 100644 index 0000000..6a767dc --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/index.md @@ -0,0 +1,1943 @@ +# table + +grafonnet.panel.table + +## Subpackages + +* [options.sortBy](options/sortBy.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAlign(value)`](#fn-fieldconfigdefaultscustomwithalign) + * [`fn withCellOptions(value)`](#fn-fieldconfigdefaultscustomwithcelloptions) + * [`fn withCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomwithcelloptionsmixin) + * [`fn withDisplayMode(value)`](#fn-fieldconfigdefaultscustomwithdisplaymode) + * [`fn withFilterable(value=true)`](#fn-fieldconfigdefaultscustomwithfilterable) + * [`fn withHidden(value=true)`](#fn-fieldconfigdefaultscustomwithhidden) + * [`fn withHideHeader(value=true)`](#fn-fieldconfigdefaultscustomwithhideheader) + * [`fn withInspect(value=true)`](#fn-fieldconfigdefaultscustomwithinspect) + * [`fn withMinWidth(value)`](#fn-fieldconfigdefaultscustomwithminwidth) + * [`fn withWidth(value)`](#fn-fieldconfigdefaultscustomwithwidth) + * [`obj cellOptions`](#obj-fieldconfigdefaultscustomcelloptions) + * [`fn withTableAutoCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableautocelloptions) + * [`fn withTableAutoCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableautocelloptionsmixin) + * [`fn withTableBarGaugeCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablebargaugecelloptions) + * [`fn withTableBarGaugeCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablebargaugecelloptionsmixin) + * [`fn withTableColorTextCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecolortextcelloptions) + * [`fn withTableColorTextCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecolortextcelloptionsmixin) + * [`fn withTableColoredBackgroundCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecoloredbackgroundcelloptions) + * [`fn withTableColoredBackgroundCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecoloredbackgroundcelloptionsmixin) + * [`fn withTableImageCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableimagecelloptions) + * [`fn withTableImageCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableimagecelloptionsmixin) + * [`fn withTableJsonViewCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablejsonviewcelloptions) + * [`fn withTableJsonViewCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablejsonviewcelloptionsmixin) + * [`fn withTableSparklineCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptions) + * [`fn withTableSparklineCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptionsmixin) + * [`obj TableAutoCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableautocelloptions) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstableautocelloptionswithtype) + * [`obj TableBarGaugeCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablebargaugecelloptions) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithmode) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithtype) + * [`fn withValueDisplayMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithvaluedisplaymode) + * [`obj TableColorTextCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecolortextcelloptions) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecolortextcelloptionswithtype) + * [`obj TableColoredBackgroundCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptions) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithmode) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithtype) + * [`obj TableImageCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableimagecelloptions) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstableimagecelloptionswithtype) + * [`obj TableJsonViewCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptions) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptionswithtype) + * [`obj TableSparklineCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptions) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrommixin) + * [`fn withHideValue(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidevalue) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtransform) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtype) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCellHeight(value)`](#fn-optionswithcellheight) + * [`fn withFooter(value={"countRows": false,"reducer": [],"show": false})`](#fn-optionswithfooter) + * [`fn withFooterMixin(value={"countRows": false,"reducer": [],"show": false})`](#fn-optionswithfootermixin) + * [`fn withFrameIndex(value=0)`](#fn-optionswithframeindex) + * [`fn withShowHeader(value=true)`](#fn-optionswithshowheader) + * [`fn withShowTypeIcons(value=true)`](#fn-optionswithshowtypeicons) + * [`fn withSortBy(value)`](#fn-optionswithsortby) + * [`fn withSortByMixin(value)`](#fn-optionswithsortbymixin) + * [`obj footer`](#obj-optionsfooter) + * [`fn withTableFooterOptions(value)`](#fn-optionsfooterwithtablefooteroptions) + * [`fn withTableFooterOptionsMixin(value)`](#fn-optionsfooterwithtablefooteroptionsmixin) + * [`obj TableFooterOptions`](#obj-optionsfootertablefooteroptions) + * [`fn withCountRows(value=true)`](#fn-optionsfootertablefooteroptionswithcountrows) + * [`fn withEnablePagination(value=true)`](#fn-optionsfootertablefooteroptionswithenablepagination) + * [`fn withFields(value)`](#fn-optionsfootertablefooteroptionswithfields) + * [`fn withFieldsMixin(value)`](#fn-optionsfootertablefooteroptionswithfieldsmixin) + * [`fn withReducer(value)`](#fn-optionsfootertablefooteroptionswithreducer) + * [`fn withReducerMixin(value)`](#fn-optionsfootertablefooteroptionswithreducermixin) + * [`fn withShow(value=true)`](#fn-optionsfootertablefooteroptionswithshow) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new table panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAlign + +```jsonnet +fieldConfig.defaults.custom.withAlign(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"left"`, `"right"`, `"center"` + +TODO -- should not be table specific! +TODO docs +###### fn fieldConfig.defaults.custom.withCellOptions + +```jsonnet +fieldConfig.defaults.custom.withCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Table cell options. Each cell has a display mode +and other potential options for that display. +###### fn fieldConfig.defaults.custom.withCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.withCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Table cell options. Each cell has a display mode +and other potential options for that display. +###### fn fieldConfig.defaults.custom.withDisplayMode + +```jsonnet +fieldConfig.defaults.custom.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"color-text"`, `"color-background"`, `"color-background-solid"`, `"gradient-gauge"`, `"lcd-gauge"`, `"json-view"`, `"basic"`, `"image"`, `"gauge"`, `"sparkline"`, `"custom"` + +Internally, this is the "type" of cell that's being displayed +in the table such as colored text, JSON, gauge, etc. +The color-background-solid, gradient-gauge, and lcd-gauge +modes are deprecated in favor of new cell subOptions +###### fn fieldConfig.defaults.custom.withFilterable + +```jsonnet +fieldConfig.defaults.custom.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withHidden + +```jsonnet +fieldConfig.defaults.custom.withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withHideHeader + +```jsonnet +fieldConfig.defaults.custom.withHideHeader(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Hides any header for a column, useful for columns that show some static content or buttons. +###### fn fieldConfig.defaults.custom.withInspect + +```jsonnet +fieldConfig.defaults.custom.withInspect(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withMinWidth + +```jsonnet +fieldConfig.defaults.custom.withMinWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withWidth + +```jsonnet +fieldConfig.defaults.custom.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### obj fieldConfig.defaults.custom.cellOptions + + +####### fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Auto mode table cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Auto mode table cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Gauge cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Gauge cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored text cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored text cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored background cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored background cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Sparkline cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Sparkline cell options +####### obj fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"lcd"`, `"gradient"` + +Enum expressing the possible display modes +for the bar gauge component of Grafana UI +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"color"`, `"text"`, `"hidden"` + +Allows for the table cell gauge display type to set the gauge mode. +####### obj fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"gradient"` + +Display mode to the "Colored Background" display +mode for table cells. Either displays a solid color (basic mode) +or a gradient. +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj fieldConfig.defaults.custom.cellOptions.TableImageCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`integer`) + - valid values: `-1`, `0`, `1` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCellHeight + +```jsonnet +options.withCellHeight(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the height of the rows +#### fn options.withFooter + +```jsonnet +options.withFooter(value={"countRows": false,"reducer": [],"show": false}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"countRows": false,"reducer": [],"show": false}` + +Controls footer options +#### fn options.withFooterMixin + +```jsonnet +options.withFooterMixin(value={"countRows": false,"reducer": [],"show": false}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"countRows": false,"reducer": [],"show": false}` + +Controls footer options +#### fn options.withFrameIndex + +```jsonnet +options.withFrameIndex(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Represents the index of the selected frame +#### fn options.withShowHeader + +```jsonnet +options.withShowHeader(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls whether the panel should show the header +#### fn options.withShowTypeIcons + +```jsonnet +options.withShowTypeIcons(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls whether the header should show icons for the column types +#### fn options.withSortBy + +```jsonnet +options.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Used to control row sorting +#### fn options.withSortByMixin + +```jsonnet +options.withSortByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Used to control row sorting +#### obj options.footer + + +##### fn options.footer.withTableFooterOptions + +```jsonnet +options.footer.withTableFooterOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Footer options +##### fn options.footer.withTableFooterOptionsMixin + +```jsonnet +options.footer.withTableFooterOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Footer options +##### obj options.footer.TableFooterOptions + + +###### fn options.footer.TableFooterOptions.withCountRows + +```jsonnet +options.footer.TableFooterOptions.withCountRows(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.footer.TableFooterOptions.withEnablePagination + +```jsonnet +options.footer.TableFooterOptions.withEnablePagination(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.footer.TableFooterOptions.withFields + +```jsonnet +options.footer.TableFooterOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn options.footer.TableFooterOptions.withFieldsMixin + +```jsonnet +options.footer.TableFooterOptions.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn options.footer.TableFooterOptions.withReducer + +```jsonnet +options.footer.TableFooterOptions.withReducer(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn options.footer.TableFooterOptions.withReducerMixin + +```jsonnet +options.footer.TableFooterOptions.withReducerMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn options.footer.TableFooterOptions.withShow + +```jsonnet +options.footer.TableFooterOptions.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/options/sortBy.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/options/sortBy.md new file mode 100644 index 0000000..20748dc --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/options/sortBy.md @@ -0,0 +1,34 @@ +# sortBy + + + +## Index + +* [`fn withDesc(value=true)`](#fn-withdesc) +* [`fn withDisplayName(value)`](#fn-withdisplayname) + +## Fields + +### fn withDesc + +```jsonnet +withDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag used to indicate descending sort order +### fn withDisplayName + +```jsonnet +withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the display name of the field to sort by \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/table/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/index.md new file mode 100644 index 0000000..460aa72 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/index.md @@ -0,0 +1,703 @@ +# text + +grafonnet.panel.text + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCode(value)`](#fn-optionswithcode) + * [`fn withCodeMixin(value)`](#fn-optionswithcodemixin) + * [`fn withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)")`](#fn-optionswithcontent) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`obj code`](#obj-optionscode) + * [`fn withLanguage(value="plaintext")`](#fn-optionscodewithlanguage) + * [`fn withShowLineNumbers(value=true)`](#fn-optionscodewithshowlinenumbers) + * [`fn withShowMiniMap(value=true)`](#fn-optionscodewithshowminimap) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new text panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCode + +```jsonnet +options.withCode(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCodeMixin + +```jsonnet +options.withCodeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withContent + +```jsonnet +options.withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)"` + + +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"html"`, `"markdown"`, `"code"` + + +#### obj options.code + + +##### fn options.code.withLanguage + +```jsonnet +options.code.withLanguage(value="plaintext") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"plaintext"` + - valid values: `"plaintext"`, `"yaml"`, `"xml"`, `"typescript"`, `"sql"`, `"go"`, `"markdown"`, `"html"`, `"json"` + + +##### fn options.code.withShowLineNumbers + +```jsonnet +options.code.withShowLineNumbers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.code.withShowMiniMap + +```jsonnet +options.code.withShowMiniMap(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/text/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/index.md new file mode 100644 index 0000000..33ffe4e --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/index.md @@ -0,0 +1,1484 @@ +# timeSeries + +grafonnet.panel.timeSeries + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new timeSeries panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`integer`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/timeSeries/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/index.md new file mode 100644 index 0000000..703936a --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/index.md @@ -0,0 +1,1472 @@ +# trend + +grafonnet.panel.trend + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withXField(value)`](#fn-optionswithxfield) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new trend panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`integer`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withXField + +```jsonnet +options.withXField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the x field to use (defaults to first number) +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/trend/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/index.md new file mode 100644 index 0000000..7ea6e4b --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/index.md @@ -0,0 +1,1550 @@ +# xyChart + +grafonnet.panel.xyChart + +## Subpackages + +* [options.series](options/series.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLabel(value)`](#fn-fieldconfigdefaultscustomwithlabel) + * [`fn withLabelValue(value)`](#fn-fieldconfigdefaultscustomwithlabelvalue) + * [`fn withLabelValueMixin(value)`](#fn-fieldconfigdefaultscustomwithlabelvaluemixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineColorMixin(value)`](#fn-fieldconfigdefaultscustomwithlinecolormixin) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointColorMixin(value)`](#fn-fieldconfigdefaultscustomwithpointcolormixin) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSizeMixin(value)`](#fn-fieldconfigdefaultscustomwithpointsizemixin) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShow(value)`](#fn-fieldconfigdefaultscustomwithshow) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj labelValue`](#obj-fieldconfigdefaultscustomlabelvalue) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithfixed) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithmode) + * [`obj lineColor`](#obj-fieldconfigdefaultscustomlinecolor) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustomlinecolorwithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustomlinecolorwithfixed) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj pointColor`](#obj-fieldconfigdefaultscustompointcolor) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustompointcolorwithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustompointcolorwithfixed) + * [`obj pointSize`](#obj-fieldconfigdefaultscustompointsize) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustompointsizewithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustompointsizewithfixed) + * [`fn withMax(value)`](#fn-fieldconfigdefaultscustompointsizewithmax) + * [`fn withMin(value)`](#fn-fieldconfigdefaultscustompointsizewithmin) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustompointsizewithmode) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDims(value)`](#fn-optionswithdims) + * [`fn withDimsMixin(value)`](#fn-optionswithdimsmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withSeries(value)`](#fn-optionswithseries) + * [`fn withSeriesMapping(value)`](#fn-optionswithseriesmapping) + * [`fn withSeriesMixin(value)`](#fn-optionswithseriesmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj dims`](#obj-optionsdims) + * [`fn withExclude(value)`](#fn-optionsdimswithexclude) + * [`fn withExcludeMixin(value)`](#fn-optionsdimswithexcludemixin) + * [`fn withFrame(value)`](#fn-optionsdimswithframe) + * [`fn withX(value)`](#fn-optionsdimswithx) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new xyChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLabel + +```jsonnet +fieldConfig.defaults.custom.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLabelValue + +```jsonnet +fieldConfig.defaults.custom.withLabelValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLabelValueMixin + +```jsonnet +fieldConfig.defaults.custom.withLabelValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineColorMixin + +```jsonnet +fieldConfig.defaults.custom.withLineColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointColorMixin + +```jsonnet +fieldConfig.defaults.custom.withPointColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointSizeMixin + +```jsonnet +fieldConfig.defaults.custom.withPointSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShow + +```jsonnet +fieldConfig.defaults.custom.withShow(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"points"`, `"lines"`, `"points+lines"` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.labelValue + + +####### fn fieldConfig.defaults.custom.labelValue.withField + +```jsonnet +fieldConfig.defaults.custom.labelValue.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.labelValue.withFixed + +```jsonnet +fieldConfig.defaults.custom.labelValue.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.labelValue.withMode + +```jsonnet +fieldConfig.defaults.custom.labelValue.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"template"` + + +###### obj fieldConfig.defaults.custom.lineColor + + +####### fn fieldConfig.defaults.custom.lineColor.withField + +```jsonnet +fieldConfig.defaults.custom.lineColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.lineColor.withFixed + +```jsonnet +fieldConfig.defaults.custom.lineColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.pointColor + + +####### fn fieldConfig.defaults.custom.pointColor.withField + +```jsonnet +fieldConfig.defaults.custom.pointColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.pointColor.withFixed + +```jsonnet +fieldConfig.defaults.custom.pointColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj fieldConfig.defaults.custom.pointSize + + +####### fn fieldConfig.defaults.custom.pointSize.withField + +```jsonnet +fieldConfig.defaults.custom.pointSize.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.pointSize.withFixed + +```jsonnet +fieldConfig.defaults.custom.pointSize.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMax + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMin + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMode + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDims + +```jsonnet +options.withDims(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withDimsMixin + +```jsonnet +options.withDimsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withSeries + +```jsonnet +options.withSeries(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withSeriesMapping + +```jsonnet +options.withSeriesMapping(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"manual"` + + +#### fn options.withSeriesMixin + +```jsonnet +options.withSeriesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.dims + + +##### fn options.dims.withExclude + +```jsonnet +options.dims.withExclude(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.dims.withExcludeMixin + +```jsonnet +options.dims.withExcludeMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.dims.withFrame + +```jsonnet +options.dims.withFrame(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.dims.withX + +```jsonnet +options.dims.withX(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/options/series.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/options/series.md new file mode 100644 index 0000000..63b8519 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/options/series.md @@ -0,0 +1,651 @@ +# series + + + +## Index + +* [`fn withAxisBorderShow(value=true)`](#fn-withaxisbordershow) +* [`fn withAxisCenteredZero(value=true)`](#fn-withaxiscenteredzero) +* [`fn withAxisColorMode(value)`](#fn-withaxiscolormode) +* [`fn withAxisGridShow(value=true)`](#fn-withaxisgridshow) +* [`fn withAxisLabel(value)`](#fn-withaxislabel) +* [`fn withAxisPlacement(value)`](#fn-withaxisplacement) +* [`fn withAxisSoftMax(value)`](#fn-withaxissoftmax) +* [`fn withAxisSoftMin(value)`](#fn-withaxissoftmin) +* [`fn withAxisWidth(value)`](#fn-withaxiswidth) +* [`fn withHideFrom(value)`](#fn-withhidefrom) +* [`fn withHideFromMixin(value)`](#fn-withhidefrommixin) +* [`fn withLabel(value)`](#fn-withlabel) +* [`fn withLabelValue(value)`](#fn-withlabelvalue) +* [`fn withLabelValueMixin(value)`](#fn-withlabelvaluemixin) +* [`fn withLineColor(value)`](#fn-withlinecolor) +* [`fn withLineColorMixin(value)`](#fn-withlinecolormixin) +* [`fn withLineStyle(value)`](#fn-withlinestyle) +* [`fn withLineStyleMixin(value)`](#fn-withlinestylemixin) +* [`fn withLineWidth(value)`](#fn-withlinewidth) +* [`fn withName(value)`](#fn-withname) +* [`fn withPointColor(value)`](#fn-withpointcolor) +* [`fn withPointColorMixin(value)`](#fn-withpointcolormixin) +* [`fn withPointSize(value)`](#fn-withpointsize) +* [`fn withPointSizeMixin(value)`](#fn-withpointsizemixin) +* [`fn withScaleDistribution(value)`](#fn-withscaledistribution) +* [`fn withScaleDistributionMixin(value)`](#fn-withscaledistributionmixin) +* [`fn withShow(value)`](#fn-withshow) +* [`fn withX(value)`](#fn-withx) +* [`fn withY(value)`](#fn-withy) +* [`obj hideFrom`](#obj-hidefrom) + * [`fn withLegend(value=true)`](#fn-hidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-hidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-hidefromwithviz) +* [`obj labelValue`](#obj-labelvalue) + * [`fn withField(value)`](#fn-labelvaluewithfield) + * [`fn withFixed(value)`](#fn-labelvaluewithfixed) + * [`fn withMode(value)`](#fn-labelvaluewithmode) +* [`obj lineColor`](#obj-linecolor) + * [`fn withField(value)`](#fn-linecolorwithfield) + * [`fn withFixed(value)`](#fn-linecolorwithfixed) +* [`obj lineStyle`](#obj-linestyle) + * [`fn withDash(value)`](#fn-linestylewithdash) + * [`fn withDashMixin(value)`](#fn-linestylewithdashmixin) + * [`fn withFill(value)`](#fn-linestylewithfill) +* [`obj pointColor`](#obj-pointcolor) + * [`fn withField(value)`](#fn-pointcolorwithfield) + * [`fn withFixed(value)`](#fn-pointcolorwithfixed) +* [`obj pointSize`](#obj-pointsize) + * [`fn withField(value)`](#fn-pointsizewithfield) + * [`fn withFixed(value)`](#fn-pointsizewithfixed) + * [`fn withMax(value)`](#fn-pointsizewithmax) + * [`fn withMin(value)`](#fn-pointsizewithmin) + * [`fn withMode(value)`](#fn-pointsizewithmode) +* [`obj scaleDistribution`](#obj-scaledistribution) + * [`fn withLinearThreshold(value)`](#fn-scaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-scaledistributionwithlog) + * [`fn withType(value)`](#fn-scaledistributionwithtype) + +## Fields + +### fn withAxisBorderShow + +```jsonnet +withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisCenteredZero + +```jsonnet +withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisColorMode + +```jsonnet +withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +### fn withAxisGridShow + +```jsonnet +withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisLabel + +```jsonnet +withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withAxisPlacement + +```jsonnet +withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +### fn withAxisSoftMax + +```jsonnet +withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withAxisSoftMin + +```jsonnet +withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withAxisWidth + +```jsonnet +withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withHideFrom + +```jsonnet +withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withHideFromMixin + +```jsonnet +withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLabel + +```jsonnet +withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +### fn withLabelValue + +```jsonnet +withLabelValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLabelValueMixin + +```jsonnet +withLabelValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineColor + +```jsonnet +withLineColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineColorMixin + +```jsonnet +withLineColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineStyle + +```jsonnet +withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLineStyleMixin + +```jsonnet +withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLineWidth + +```jsonnet +withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPointColor + +```jsonnet +withPointColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointColorMixin + +```jsonnet +withPointColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointSize + +```jsonnet +withPointSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointSizeMixin + +```jsonnet +withPointSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScaleDistribution + +```jsonnet +withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withScaleDistributionMixin + +```jsonnet +withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withShow + +```jsonnet +withShow(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"points"`, `"lines"`, `"points+lines"` + + +### fn withX + +```jsonnet +withX(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withY + +```jsonnet +withY(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj hideFrom + + +#### fn hideFrom.withLegend + +```jsonnet +hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn hideFrom.withTooltip + +```jsonnet +hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn hideFrom.withViz + +```jsonnet +hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj labelValue + + +#### fn labelValue.withField + +```jsonnet +labelValue.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn labelValue.withFixed + +```jsonnet +labelValue.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn labelValue.withMode + +```jsonnet +labelValue.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"template"` + + +### obj lineColor + + +#### fn lineColor.withField + +```jsonnet +lineColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn lineColor.withFixed + +```jsonnet +lineColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj lineStyle + + +#### fn lineStyle.withDash + +```jsonnet +lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn lineStyle.withDashMixin + +```jsonnet +lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn lineStyle.withFill + +```jsonnet +lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +### obj pointColor + + +#### fn pointColor.withField + +```jsonnet +pointColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn pointColor.withFixed + +```jsonnet +pointColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj pointSize + + +#### fn pointSize.withField + +```jsonnet +pointSize.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn pointSize.withFixed + +```jsonnet +pointSize.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMax + +```jsonnet +pointSize.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMin + +```jsonnet +pointSize.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMode + +```jsonnet +pointSize.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +### obj scaleDistribution + + +#### fn scaleDistribution.withLinearThreshold + +```jsonnet +scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn scaleDistribution.withLog + +```jsonnet +scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn scaleDistribution.withType + +```jsonnet +scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/panelOptions/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/queryOptions/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/queryOptions/transformation.md new file mode 100644 index 0000000..e14cb99 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/queryOptions/transformation.md @@ -0,0 +1,102 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/mapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/mapping.md new file mode 100644 index 0000000..7f10ced --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/mapping.md @@ -0,0 +1,457 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType(value)`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType(value)`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType(value)`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/override.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/threshold/step.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..5212a21 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/panel/xyChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`null`,`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/preferences.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/preferences.md new file mode 100644 index 0000000..79b7bfc --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/preferences.md @@ -0,0 +1,210 @@ +# preferences + +grafonnet.preferences + +## Index + +* [`fn withCookiePreferences(value)`](#fn-withcookiepreferences) +* [`fn withCookiePreferencesMixin(value)`](#fn-withcookiepreferencesmixin) +* [`fn withHomeDashboardUID(value)`](#fn-withhomedashboarduid) +* [`fn withLanguage(value)`](#fn-withlanguage) +* [`fn withQueryHistory(value)`](#fn-withqueryhistory) +* [`fn withQueryHistoryMixin(value)`](#fn-withqueryhistorymixin) +* [`fn withTheme(value)`](#fn-withtheme) +* [`fn withTimezone(value)`](#fn-withtimezone) +* [`fn withWeekStart(value)`](#fn-withweekstart) +* [`obj cookiePreferences`](#obj-cookiepreferences) + * [`fn withAnalytics(value)`](#fn-cookiepreferenceswithanalytics) + * [`fn withAnalyticsMixin(value)`](#fn-cookiepreferenceswithanalyticsmixin) + * [`fn withFunctional(value)`](#fn-cookiepreferenceswithfunctional) + * [`fn withFunctionalMixin(value)`](#fn-cookiepreferenceswithfunctionalmixin) + * [`fn withPerformance(value)`](#fn-cookiepreferenceswithperformance) + * [`fn withPerformanceMixin(value)`](#fn-cookiepreferenceswithperformancemixin) +* [`obj queryHistory`](#obj-queryhistory) + * [`fn withHomeTab(value)`](#fn-queryhistorywithhometab) + +## Fields + +### fn withCookiePreferences + +```jsonnet +withCookiePreferences(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withCookiePreferencesMixin + +```jsonnet +withCookiePreferencesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHomeDashboardUID + +```jsonnet +withHomeDashboardUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + +UID for the home dashboard +### fn withLanguage + +```jsonnet +withLanguage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Selected language (beta) +### fn withQueryHistory + +```jsonnet +withQueryHistory(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryHistoryMixin + +```jsonnet +withQueryHistoryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTheme + +```jsonnet +withTheme(value) +``` + +PARAMETERS: + +* **value** (`string`) + +light, dark, empty is default +### fn withTimezone + +```jsonnet +withTimezone(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The timezone selection +TODO: this should use the timezone defined in common +### fn withWeekStart + +```jsonnet +withWeekStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +day of the week (sunday, monday, etc) +### obj cookiePreferences + + +#### fn cookiePreferences.withAnalytics + +```jsonnet +cookiePreferences.withAnalytics(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withAnalyticsMixin + +```jsonnet +cookiePreferences.withAnalyticsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withFunctional + +```jsonnet +cookiePreferences.withFunctional(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withFunctionalMixin + +```jsonnet +cookiePreferences.withFunctionalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withPerformance + +```jsonnet +cookiePreferences.withPerformance(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withPerformanceMixin + +```jsonnet +cookiePreferences.withPerformanceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj queryHistory + + +#### fn queryHistory.withHomeTab + +```jsonnet +queryHistory.withHomeTab(value) +``` + +PARAMETERS: + +* **value** (`string`) + +one of: '' | 'query' | 'starred'; \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/publicdashboard.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/publicdashboard.md similarity index 50% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/publicdashboard.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/publicdashboard.md index 0fc2cde..9cb78fb 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/publicdashboard.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/publicdashboard.md @@ -5,58 +5,80 @@ grafonnet.publicdashboard ## Index * [`fn withAccessToken(value)`](#fn-withaccesstoken) -* [`fn withAnnotationsEnabled(value)`](#fn-withannotationsenabled) +* [`fn withAnnotationsEnabled(value=true)`](#fn-withannotationsenabled) * [`fn withDashboardUid(value)`](#fn-withdashboarduid) -* [`fn withIsEnabled(value)`](#fn-withisenabled) -* [`fn withTimeSelectionEnabled(value)`](#fn-withtimeselectionenabled) +* [`fn withIsEnabled(value=true)`](#fn-withisenabled) +* [`fn withTimeSelectionEnabled(value=true)`](#fn-withtimeselectionenabled) * [`fn withUid(value)`](#fn-withuid) ## Fields ### fn withAccessToken -```ts +```jsonnet withAccessToken(value) ``` -Unique public access token +PARAMETERS: + +* **value** (`string`) +Unique public access token ### fn withAnnotationsEnabled -```ts -withAnnotationsEnabled(value) +```jsonnet +withAnnotationsEnabled(value=true) ``` -Flag that indicates if annotations are enabled +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +Flag that indicates if annotations are enabled ### fn withDashboardUid -```ts +```jsonnet withDashboardUid(value) ``` -Dashboard unique identifier referenced by this public dashboard +PARAMETERS: +* **value** (`string`) + +Dashboard unique identifier referenced by this public dashboard ### fn withIsEnabled -```ts -withIsEnabled(value) +```jsonnet +withIsEnabled(value=true) ``` -Flag that indicates if the public dashboard is enabled +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +Flag that indicates if the public dashboard is enabled ### fn withTimeSelectionEnabled -```ts -withTimeSelectionEnabled(value) +```jsonnet +withTimeSelectionEnabled(value=true) ``` -Flag that indicates if the time range picker is enabled +PARAMETERS: +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if the time range picker is enabled ### fn withUid -```ts +```jsonnet withUid(value) ``` -Unique public dashboard identifier +PARAMETERS: + +* **value** (`string`) + +Unique public dashboard identifier \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md new file mode 100644 index 0000000..43b6cf5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md @@ -0,0 +1,69 @@ +# dimensionFilters + + + +## Index + +* [`fn withDimension(value)`](#fn-withdimension) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withOperator(value)`](#fn-withoperator) + +## Fields + +### fn withDimension + +```jsonnet +withDimension(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of Dimension to be filtered on. +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated filter is deprecated in favour of filters to support multiselect. +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to match with the filter. +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to match with the filter. +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureMonitor/resources.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureMonitor/resources.md new file mode 100644 index 0000000..18bb633 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureMonitor/resources.md @@ -0,0 +1,68 @@ +# resources + + + +## Index + +* [`fn withMetricNamespace(value)`](#fn-withmetricnamespace) +* [`fn withRegion(value)`](#fn-withregion) +* [`fn withResourceGroup(value)`](#fn-withresourcegroup) +* [`fn withResourceName(value)`](#fn-withresourcename) +* [`fn withSubscription(value)`](#fn-withsubscription) + +## Fields + +### fn withMetricNamespace + +```jsonnet +withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRegion + +```jsonnet +withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceGroup + +```jsonnet +withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceName + +```jsonnet +withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withSubscription + +```jsonnet +withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureTraces/filters.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureTraces/filters.md new file mode 100644 index 0000000..0c5c718 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/azureTraces/filters.md @@ -0,0 +1,57 @@ +# filters + + + +## Index + +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withOperation(value)`](#fn-withoperation) +* [`fn withProperty(value)`](#fn-withproperty) + +## Fields + +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to filter by. +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to filter by. +### fn withOperation + +```jsonnet +withOperation(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Comparison operator to use. Either equals or not equals. +### fn withProperty + +```jsonnet +withProperty(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Property name, auto-populated based on available traces. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/azureMonitor.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/index.md similarity index 64% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/azureMonitor.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/index.md index fdac5da..2578f17 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/azureMonitor.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/azureMonitor/index.md @@ -2,6 +2,12 @@ grafonnet.query.azureMonitor +## Subpackages + +* [azureMonitor.dimensionFilters](azureMonitor/dimensionFilters.md) +* [azureMonitor.resources](azureMonitor/resources.md) +* [azureTraces.filters](azureTraces/filters.md) + ## Index * [`fn withAzureLogAnalytics(value)`](#fn-withazureloganalytics) @@ -15,7 +21,7 @@ grafonnet.query.azureMonitor * [`fn withDatasource(value)`](#fn-withdatasource) * [`fn withGrafanaTemplateVariableFn(value)`](#fn-withgrafanatemplatevariablefn) * [`fn withGrafanaTemplateVariableFnMixin(value)`](#fn-withgrafanatemplatevariablefnmixin) -* [`fn withHide(value)`](#fn-withhide) +* [`fn withHide(value=true)`](#fn-withhide) * [`fn withNamespace(value)`](#fn-withnamespace) * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRefId(value)`](#fn-withrefid) @@ -26,11 +32,14 @@ grafonnet.query.azureMonitor * [`fn withSubscriptions(value)`](#fn-withsubscriptions) * [`fn withSubscriptionsMixin(value)`](#fn-withsubscriptionsmixin) * [`obj azureLogAnalytics`](#obj-azureloganalytics) + * [`fn withDashboardTime(value=true)`](#fn-azureloganalyticswithdashboardtime) + * [`fn withIntersectTime(value=true)`](#fn-azureloganalyticswithintersecttime) * [`fn withQuery(value)`](#fn-azureloganalyticswithquery) * [`fn withResource(value)`](#fn-azureloganalyticswithresource) * [`fn withResources(value)`](#fn-azureloganalyticswithresources) * [`fn withResourcesMixin(value)`](#fn-azureloganalyticswithresourcesmixin) * [`fn withResultFormat(value)`](#fn-azureloganalyticswithresultformat) + * [`fn withTimeColumn(value)`](#fn-azureloganalyticswithtimecolumn) * [`fn withWorkspace(value)`](#fn-azureloganalyticswithworkspace) * [`obj azureMonitor`](#obj-azuremonitor) * [`fn withAggregation(value)`](#fn-azuremonitorwithaggregation) @@ -54,18 +63,6 @@ grafonnet.query.azureMonitor * [`fn withTimeGrain(value)`](#fn-azuremonitorwithtimegrain) * [`fn withTimeGrainUnit(value)`](#fn-azuremonitorwithtimegrainunit) * [`fn withTop(value)`](#fn-azuremonitorwithtop) - * [`obj dimensionFilters`](#obj-azuremonitordimensionfilters) - * [`fn withDimension(value)`](#fn-azuremonitordimensionfilterswithdimension) - * [`fn withFilter(value)`](#fn-azuremonitordimensionfilterswithfilter) - * [`fn withFilters(value)`](#fn-azuremonitordimensionfilterswithfilters) - * [`fn withFiltersMixin(value)`](#fn-azuremonitordimensionfilterswithfiltersmixin) - * [`fn withOperator(value)`](#fn-azuremonitordimensionfilterswithoperator) - * [`obj resources`](#obj-azuremonitorresources) - * [`fn withMetricNamespace(value)`](#fn-azuremonitorresourceswithmetricnamespace) - * [`fn withRegion(value)`](#fn-azuremonitorresourceswithregion) - * [`fn withResourceGroup(value)`](#fn-azuremonitorresourceswithresourcegroup) - * [`fn withResourceName(value)`](#fn-azuremonitorresourceswithresourcename) - * [`fn withSubscription(value)`](#fn-azuremonitorresourceswithsubscription) * [`obj azureResourceGraph`](#obj-azureresourcegraph) * [`fn withQuery(value)`](#fn-azureresourcegraphwithquery) * [`fn withResultFormat(value)`](#fn-azureresourcegraphwithresultformat) @@ -79,11 +76,6 @@ grafonnet.query.azureMonitor * [`fn withResultFormat(value)`](#fn-azuretraceswithresultformat) * [`fn withTraceTypes(value)`](#fn-azuretraceswithtracetypes) * [`fn withTraceTypesMixin(value)`](#fn-azuretraceswithtracetypesmixin) - * [`obj filters`](#obj-azuretracesfilters) - * [`fn withFilters(value)`](#fn-azuretracesfilterswithfilters) - * [`fn withFiltersMixin(value)`](#fn-azuretracesfilterswithfiltersmixin) - * [`fn withOperation(value)`](#fn-azuretracesfilterswithoperation) - * [`fn withProperty(value)`](#fn-azuretracesfilterswithproperty) * [`obj grafanaTemplateVariableFn`](#obj-grafanatemplatevariablefn) * [`fn withAppInsightsGroupByQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquery) * [`fn withAppInsightsGroupByQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquerymixin) @@ -158,785 +150,935 @@ grafonnet.query.azureMonitor ### fn withAzureLogAnalytics -```ts +```jsonnet withAzureLogAnalytics(value) ``` -Azure Monitor Logs sub-query properties +PARAMETERS: +* **value** (`object`) + +Azure Monitor Logs sub-query properties ### fn withAzureLogAnalyticsMixin -```ts +```jsonnet withAzureLogAnalyticsMixin(value) ``` -Azure Monitor Logs sub-query properties +PARAMETERS: + +* **value** (`object`) +Azure Monitor Logs sub-query properties ### fn withAzureMonitor -```ts +```jsonnet withAzureMonitor(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withAzureMonitorMixin -```ts +```jsonnet withAzureMonitorMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withAzureResourceGraph -```ts +```jsonnet withAzureResourceGraph(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withAzureResourceGraphMixin -```ts +```jsonnet withAzureResourceGraphMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withAzureTraces -```ts +```jsonnet withAzureTraces(value) ``` -Application Insights Traces sub-query properties +PARAMETERS: +* **value** (`object`) + +Application Insights Traces sub-query properties ### fn withAzureTracesMixin -```ts +```jsonnet withAzureTracesMixin(value) ``` -Application Insights Traces sub-query properties +PARAMETERS: + +* **value** (`object`) +Application Insights Traces sub-query properties ### fn withDatasource -```ts +```jsonnet withDatasource(value) ``` +PARAMETERS: + +* **value** (`string`) + For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null - ### fn withGrafanaTemplateVariableFn -```ts +```jsonnet withGrafanaTemplateVariableFn(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withGrafanaTemplateVariableFnMixin -```ts +```jsonnet withGrafanaTemplateVariableFnMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withHide -```ts -withHide(value) +```jsonnet +withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - ### fn withNamespace -```ts +```jsonnet withNamespace(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withQueryType -```ts +```jsonnet withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - ### fn withRefId -```ts +```jsonnet withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful. - ### fn withRegion -```ts +```jsonnet withRegion(value) ``` +PARAMETERS: + +* **value** (`string`) + Azure Monitor query type. queryType: #AzureQueryType - ### fn withResource -```ts +```jsonnet withResource(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withResourceGroup -```ts +```jsonnet withResourceGroup(value) ``` -Template variables params. These exist for backwards compatiblity with legacy template variables. +PARAMETERS: +* **value** (`string`) + +Template variables params. These exist for backwards compatiblity with legacy template variables. ### fn withSubscription -```ts +```jsonnet withSubscription(value) ``` -Azure subscription containing the resource(s) to be queried. +PARAMETERS: +* **value** (`string`) + +Azure subscription containing the resource(s) to be queried. ### fn withSubscriptions -```ts +```jsonnet withSubscriptions(value) ``` -Subscriptions to be queried via Azure Resource Graph. +PARAMETERS: + +* **value** (`array`) +Subscriptions to be queried via Azure Resource Graph. ### fn withSubscriptionsMixin -```ts +```jsonnet withSubscriptionsMixin(value) ``` -Subscriptions to be queried via Azure Resource Graph. +PARAMETERS: + +* **value** (`array`) +Subscriptions to be queried via Azure Resource Graph. ### obj azureLogAnalytics +#### fn azureLogAnalytics.withDashboardTime + +```jsonnet +azureLogAnalytics.withDashboardTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false. +#### fn azureLogAnalytics.withIntersectTime + +```jsonnet +azureLogAnalytics.withIntersectTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +@deprecated Use dashboardTime instead #### fn azureLogAnalytics.withQuery -```ts -withQuery(value) +```jsonnet +azureLogAnalytics.withQuery(value) ``` -KQL query to be executed. +PARAMETERS: +* **value** (`string`) + +KQL query to be executed. #### fn azureLogAnalytics.withResource -```ts -withResource(value) +```jsonnet +azureLogAnalytics.withResource(value) ``` -@deprecated Use resources instead +PARAMETERS: +* **value** (`string`) + +@deprecated Use resources instead #### fn azureLogAnalytics.withResources -```ts -withResources(value) +```jsonnet +azureLogAnalytics.withResources(value) ``` -Array of resource URIs to be queried. +PARAMETERS: + +* **value** (`array`) +Array of resource URIs to be queried. #### fn azureLogAnalytics.withResourcesMixin -```ts -withResourcesMixin(value) +```jsonnet +azureLogAnalytics.withResourcesMixin(value) ``` -Array of resource URIs to be queried. +PARAMETERS: + +* **value** (`array`) +Array of resource URIs to be queried. #### fn azureLogAnalytics.withResultFormat -```ts -withResultFormat(value) +```jsonnet +azureLogAnalytics.withResultFormat(value) ``` +PARAMETERS: + +* **value** (`string`) + - valid values: `"table"`, `"time_series"`, `"trace"` -Accepted values for `value` are "table", "time_series", "trace" +#### fn azureLogAnalytics.withTimeColumn + +```jsonnet +azureLogAnalytics.withTimeColumn(value) +``` +PARAMETERS: + +* **value** (`string`) + +If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated #### fn azureLogAnalytics.withWorkspace -```ts -withWorkspace(value) +```jsonnet +azureLogAnalytics.withWorkspace(value) ``` -Workspace ID. This was removed in Grafana 8, but remains for backwards compat +PARAMETERS: + +* **value** (`string`) +Workspace ID. This was removed in Grafana 8, but remains for backwards compat. ### obj azureMonitor #### fn azureMonitor.withAggregation -```ts -withAggregation(value) +```jsonnet +azureMonitor.withAggregation(value) ``` -The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric. +PARAMETERS: + +* **value** (`string`) +The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric. #### fn azureMonitor.withAlias -```ts -withAlias(value) +```jsonnet +azureMonitor.withAlias(value) ``` -Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail. +PARAMETERS: + +* **value** (`string`) +Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail. #### fn azureMonitor.withAllowedTimeGrainsMs -```ts -withAllowedTimeGrainsMs(value) +```jsonnet +azureMonitor.withAllowedTimeGrainsMs(value) ``` -Time grains that are supported by the metric. +PARAMETERS: +* **value** (`array`) + +Time grains that are supported by the metric. #### fn azureMonitor.withAllowedTimeGrainsMsMixin -```ts -withAllowedTimeGrainsMsMixin(value) +```jsonnet +azureMonitor.withAllowedTimeGrainsMsMixin(value) ``` -Time grains that are supported by the metric. +PARAMETERS: +* **value** (`array`) + +Time grains that are supported by the metric. #### fn azureMonitor.withCustomNamespace -```ts -withCustomNamespace(value) +```jsonnet +azureMonitor.withCustomNamespace(value) ``` -Used as the value for the metricNamespace property when it's different from the resource namespace. +PARAMETERS: + +* **value** (`string`) +Used as the value for the metricNamespace property when it's different from the resource namespace. #### fn azureMonitor.withDimension -```ts -withDimension(value) +```jsonnet +azureMonitor.withDimension(value) ``` -@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration +PARAMETERS: +* **value** (`string`) + +@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration #### fn azureMonitor.withDimensionFilter -```ts -withDimensionFilter(value) +```jsonnet +azureMonitor.withDimensionFilter(value) ``` -@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration +PARAMETERS: +* **value** (`string`) + +@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration #### fn azureMonitor.withDimensionFilters -```ts -withDimensionFilters(value) +```jsonnet +azureMonitor.withDimensionFilters(value) ``` -Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. +PARAMETERS: + +* **value** (`array`) +Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. #### fn azureMonitor.withDimensionFiltersMixin -```ts -withDimensionFiltersMixin(value) +```jsonnet +azureMonitor.withDimensionFiltersMixin(value) ``` -Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. +PARAMETERS: +* **value** (`array`) + +Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. #### fn azureMonitor.withMetricDefinition -```ts -withMetricDefinition(value) +```jsonnet +azureMonitor.withMetricDefinition(value) ``` -@deprecated Use metricNamespace instead +PARAMETERS: +* **value** (`string`) + +@deprecated Use metricNamespace instead #### fn azureMonitor.withMetricName -```ts -withMetricName(value) +```jsonnet +azureMonitor.withMetricName(value) ``` -The metric to query data for within the specified metricNamespace. e.g. UsedCapacity +PARAMETERS: + +* **value** (`string`) +The metric to query data for within the specified metricNamespace. e.g. UsedCapacity #### fn azureMonitor.withMetricNamespace -```ts -withMetricNamespace(value) +```jsonnet +azureMonitor.withMetricNamespace(value) ``` +PARAMETERS: + +* **value** (`string`) + metricNamespace is used as the resource type (or resource namespace). It's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts Kept the name of the variable as metricNamespace to avoid backward incompatibility issues. - #### fn azureMonitor.withRegion -```ts -withRegion(value) +```jsonnet +azureMonitor.withRegion(value) ``` -The Azure region containing the resource(s). +PARAMETERS: + +* **value** (`string`) +The Azure region containing the resource(s). #### fn azureMonitor.withResourceGroup -```ts -withResourceGroup(value) +```jsonnet +azureMonitor.withResourceGroup(value) ``` -@deprecated Use resources instead +PARAMETERS: -#### fn azureMonitor.withResourceName - -```ts -withResourceName(value) -``` +* **value** (`string`) @deprecated Use resources instead +#### fn azureMonitor.withResourceName -#### fn azureMonitor.withResourceUri - -```ts -withResourceUri(value) -``` - -@deprecated Use resourceGroup, resourceName and metricNamespace instead - -#### fn azureMonitor.withResources - -```ts -withResources(value) -``` - -Array of resource URIs to be queried. - -#### fn azureMonitor.withResourcesMixin - -```ts -withResourcesMixin(value) -``` - -Array of resource URIs to be queried. - -#### fn azureMonitor.withTimeGrain - -```ts -withTimeGrain(value) -``` - -The granularity of data points to be queried. Defaults to auto. - -#### fn azureMonitor.withTimeGrainUnit - -```ts -withTimeGrainUnit(value) -``` - -@deprecated - -#### fn azureMonitor.withTop - -```ts -withTop(value) -``` - -Maximum number of records to return. Defaults to 10. - -#### obj azureMonitor.dimensionFilters - - -##### fn azureMonitor.dimensionFilters.withDimension - -```ts -withDimension(value) -``` - -Name of Dimension to be filtered on. - -##### fn azureMonitor.dimensionFilters.withFilter - -```ts -withFilter(value) -``` - -@deprecated filter is deprecated in favour of filters to support multiselect. - -##### fn azureMonitor.dimensionFilters.withFilters - -```ts -withFilters(value) +```jsonnet +azureMonitor.withResourceName(value) ``` -Values to match with the filter. +PARAMETERS: -##### fn azureMonitor.dimensionFilters.withFiltersMixin - -```ts -withFiltersMixin(value) -``` +* **value** (`string`) -Values to match with the filter. - -##### fn azureMonitor.dimensionFilters.withOperator +@deprecated Use resources instead +#### fn azureMonitor.withResourceUri -```ts -withOperator(value) +```jsonnet +azureMonitor.withResourceUri(value) ``` -String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators. - -#### obj azureMonitor.resources +PARAMETERS: +* **value** (`string`) -##### fn azureMonitor.resources.withMetricNamespace +@deprecated Use resourceGroup, resourceName and metricNamespace instead +#### fn azureMonitor.withResources -```ts -withMetricNamespace(value) +```jsonnet +azureMonitor.withResources(value) ``` +PARAMETERS: +* **value** (`array`) -##### fn azureMonitor.resources.withRegion +Array of resource URIs to be queried. +#### fn azureMonitor.withResourcesMixin -```ts -withRegion(value) +```jsonnet +azureMonitor.withResourcesMixin(value) ``` +PARAMETERS: +* **value** (`array`) -##### fn azureMonitor.resources.withResourceGroup +Array of resource URIs to be queried. +#### fn azureMonitor.withTimeGrain -```ts -withResourceGroup(value) +```jsonnet +azureMonitor.withTimeGrain(value) ``` +PARAMETERS: +* **value** (`string`) -##### fn azureMonitor.resources.withResourceName +The granularity of data points to be queried. Defaults to auto. +#### fn azureMonitor.withTimeGrainUnit -```ts -withResourceName(value) +```jsonnet +azureMonitor.withTimeGrainUnit(value) ``` +PARAMETERS: +* **value** (`string`) -##### fn azureMonitor.resources.withSubscription +@deprecated +#### fn azureMonitor.withTop -```ts -withSubscription(value) +```jsonnet +azureMonitor.withTop(value) ``` +PARAMETERS: +* **value** (`string`) +Maximum number of records to return. Defaults to 10. ### obj azureResourceGraph #### fn azureResourceGraph.withQuery -```ts -withQuery(value) +```jsonnet +azureResourceGraph.withQuery(value) ``` -Azure Resource Graph KQL query to be executed. +PARAMETERS: + +* **value** (`string`) +Azure Resource Graph KQL query to be executed. #### fn azureResourceGraph.withResultFormat -```ts -withResultFormat(value) +```jsonnet +azureResourceGraph.withResultFormat(value) ``` -Specifies the format results should be returned as. Defaults to table. +PARAMETERS: + +* **value** (`string`) +Specifies the format results should be returned as. Defaults to table. ### obj azureTraces #### fn azureTraces.withFilters -```ts -withFilters(value) +```jsonnet +azureTraces.withFilters(value) ``` -Filters for property values. +PARAMETERS: + +* **value** (`array`) +Filters for property values. #### fn azureTraces.withFiltersMixin -```ts -withFiltersMixin(value) +```jsonnet +azureTraces.withFiltersMixin(value) ``` -Filters for property values. +PARAMETERS: +* **value** (`array`) + +Filters for property values. #### fn azureTraces.withOperationId -```ts -withOperationId(value) +```jsonnet +azureTraces.withOperationId(value) ``` -Operation ID. Used only for Traces queries. +PARAMETERS: + +* **value** (`string`) +Operation ID. Used only for Traces queries. #### fn azureTraces.withQuery -```ts -withQuery(value) +```jsonnet +azureTraces.withQuery(value) ``` -KQL query to be executed. +PARAMETERS: + +* **value** (`string`) +KQL query to be executed. #### fn azureTraces.withResources -```ts -withResources(value) +```jsonnet +azureTraces.withResources(value) ``` -Array of resource URIs to be queried. +PARAMETERS: +* **value** (`array`) + +Array of resource URIs to be queried. #### fn azureTraces.withResourcesMixin -```ts -withResourcesMixin(value) +```jsonnet +azureTraces.withResourcesMixin(value) ``` -Array of resource URIs to be queried. +PARAMETERS: + +* **value** (`array`) +Array of resource URIs to be queried. #### fn azureTraces.withResultFormat -```ts -withResultFormat(value) +```jsonnet +azureTraces.withResultFormat(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"table"`, `"time_series"`, `"trace"` -Accepted values for `value` are "table", "time_series", "trace" #### fn azureTraces.withTraceTypes -```ts -withTraceTypes(value) +```jsonnet +azureTraces.withTraceTypes(value) ``` -Types of events to filter by. +PARAMETERS: -#### fn azureTraces.withTraceTypesMixin - -```ts -withTraceTypesMixin(value) -``` +* **value** (`array`) Types of events to filter by. +#### fn azureTraces.withTraceTypesMixin -#### obj azureTraces.filters - - -##### fn azureTraces.filters.withFilters - -```ts -withFilters(value) -``` - -Values to filter by. - -##### fn azureTraces.filters.withFiltersMixin - -```ts -withFiltersMixin(value) -``` - -Values to filter by. - -##### fn azureTraces.filters.withOperation - -```ts -withOperation(value) +```jsonnet +azureTraces.withTraceTypesMixin(value) ``` -Comparison operator to use. Either equals or not equals. +PARAMETERS: -##### fn azureTraces.filters.withProperty - -```ts -withProperty(value) -``` - -Property name, auto-populated based on available traces. +* **value** (`array`) +Types of events to filter by. ### obj grafanaTemplateVariableFn #### fn grafanaTemplateVariableFn.withAppInsightsGroupByQuery -```ts -withAppInsightsGroupByQuery(value) +```jsonnet +grafanaTemplateVariableFn.withAppInsightsGroupByQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin -```ts -withAppInsightsGroupByQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQuery -```ts -withAppInsightsMetricNameQuery(value) +```jsonnet +grafanaTemplateVariableFn.withAppInsightsMetricNameQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin -```ts -withAppInsightsMetricNameQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withMetricDefinitionsQuery -```ts -withMetricDefinitionsQuery(value) +```jsonnet +grafanaTemplateVariableFn.withMetricDefinitionsQuery(value) ``` -@deprecated Use MetricNamespaceQuery instead +PARAMETERS: +* **value** (`object`) + +@deprecated Use MetricNamespaceQuery instead #### fn grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin -```ts -withMetricDefinitionsQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin(value) ``` -@deprecated Use MetricNamespaceQuery instead +PARAMETERS: + +* **value** (`object`) +@deprecated Use MetricNamespaceQuery instead #### fn grafanaTemplateVariableFn.withMetricNamesQuery -```ts -withMetricNamesQuery(value) +```jsonnet +grafanaTemplateVariableFn.withMetricNamesQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withMetricNamesQueryMixin -```ts -withMetricNamesQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withMetricNamesQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withMetricNamespaceQuery -```ts -withMetricNamespaceQuery(value) +```jsonnet +grafanaTemplateVariableFn.withMetricNamespaceQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withMetricNamespaceQueryMixin -```ts -withMetricNamespaceQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withMetricNamespaceQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withResourceGroupsQuery -```ts -withResourceGroupsQuery(value) +```jsonnet +grafanaTemplateVariableFn.withResourceGroupsQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withResourceGroupsQueryMixin -```ts -withResourceGroupsQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withResourceGroupsQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withResourceNamesQuery -```ts -withResourceNamesQuery(value) +```jsonnet +grafanaTemplateVariableFn.withResourceNamesQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withResourceNamesQueryMixin -```ts -withResourceNamesQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withResourceNamesQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withSubscriptionsQuery -```ts -withSubscriptionsQuery(value) +```jsonnet +grafanaTemplateVariableFn.withSubscriptionsQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withSubscriptionsQueryMixin -```ts -withSubscriptionsQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withSubscriptionsQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withUnknownQuery -```ts -withUnknownQuery(value) +```jsonnet +grafanaTemplateVariableFn.withUnknownQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withUnknownQueryMixin -```ts -withUnknownQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withUnknownQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withWorkspacesQuery -```ts -withWorkspacesQuery(value) +```jsonnet +grafanaTemplateVariableFn.withWorkspacesQuery(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn grafanaTemplateVariableFn.withWorkspacesQueryMixin -```ts -withWorkspacesQueryMixin(value) +```jsonnet +grafanaTemplateVariableFn.withWorkspacesQueryMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### obj grafanaTemplateVariableFn.AppInsightsGroupByQuery @@ -944,28 +1086,36 @@ withWorkspacesQueryMixin(value) ##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"AppInsightsGroupByQuery"` -Accepted values for `value` are "AppInsightsGroupByQuery" ##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName -```ts -withMetricName(value) +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.AppInsightsMetricNameQuery @@ -973,20 +1123,25 @@ withRawQuery(value) ##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"AppInsightsMetricNameQuery"` -Accepted values for `value` are "AppInsightsMetricNameQuery" ##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.MetricDefinitionsQuery @@ -994,52 +1149,69 @@ withRawQuery(value) ##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"MetricDefinitionsQuery"` -Accepted values for `value` are "MetricDefinitionsQuery" ##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace -```ts -withMetricNamespace(value) +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup -```ts -withResourceGroup(value) +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName -```ts -withResourceName(value) +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription -```ts -withSubscription(value) +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.MetricNamesQuery @@ -1047,52 +1219,69 @@ withSubscription(value) ##### fn grafanaTemplateVariableFn.MetricNamesQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"MetricNamesQuery"` -Accepted values for `value` are "MetricNamesQuery" ##### fn grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace -```ts -withMetricNamespace(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup -```ts -withResourceGroup(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceName -```ts -withResourceName(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withResourceName(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricNamesQuery.withSubscription -```ts -withSubscription(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withSubscription(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.MetricNamespaceQuery @@ -1100,52 +1289,69 @@ withSubscription(value) ##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"MetricNamespaceQuery"` -Accepted values for `value` are "MetricNamespaceQuery" ##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace -```ts -withMetricNamespace(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup -```ts -withResourceGroup(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName -```ts -withResourceName(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription -```ts -withSubscription(value) +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.ResourceGroupsQuery @@ -1153,28 +1359,36 @@ withSubscription(value) ##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"ResourceGroupsQuery"` -Accepted values for `value` are "ResourceGroupsQuery" ##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription -```ts -withSubscription(value) +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.ResourceNamesQuery @@ -1182,44 +1396,58 @@ withSubscription(value) ##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"ResourceNamesQuery"` -Accepted values for `value` are "ResourceNamesQuery" ##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace -```ts -withMetricNamespace(value) +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup -```ts -withResourceGroup(value) +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription -```ts -withSubscription(value) +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.SubscriptionsQuery @@ -1227,20 +1455,25 @@ withSubscription(value) ##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.SubscriptionsQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"SubscriptionsQuery"` -Accepted values for `value` are "SubscriptionsQuery" ##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.UnknownQuery @@ -1248,20 +1481,25 @@ withRawQuery(value) ##### fn grafanaTemplateVariableFn.UnknownQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.UnknownQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"UnknownQuery"` -Accepted values for `value` are "UnknownQuery" ##### fn grafanaTemplateVariableFn.UnknownQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.UnknownQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) #### obj grafanaTemplateVariableFn.WorkspacesQuery @@ -1269,26 +1507,34 @@ withRawQuery(value) ##### fn grafanaTemplateVariableFn.WorkspacesQuery.withKind -```ts -withKind(value) +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withKind(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"WorkspacesQuery"` -Accepted values for `value` are "WorkspacesQuery" ##### fn grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery -```ts -withRawQuery(value) +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn grafanaTemplateVariableFn.WorkspacesQuery.withSubscription -```ts -withSubscription(value) +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withSubscription(value) ``` +PARAMETERS: + +* **value** (`string`) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md new file mode 100644 index 0000000..a59d777 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md @@ -0,0 +1,57 @@ +# logGroups + + + +## Index + +* [`fn withAccountId(value)`](#fn-withaccountid) +* [`fn withAccountLabel(value)`](#fn-withaccountlabel) +* [`fn withArn(value)`](#fn-witharn) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withAccountId + +```jsonnet +withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AccountId of the log group +### fn withAccountLabel + +```jsonnet +withAccountLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Label of the log group +### fn withArn + +```jsonnet +withArn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ARN of the log group +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the log group \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md new file mode 100644 index 0000000..a7f0402 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md @@ -0,0 +1,32 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType(value)`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md new file mode 100644 index 0000000..a7f0402 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md @@ -0,0 +1,32 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType(value)`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md new file mode 100644 index 0000000..a7f0402 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md @@ -0,0 +1,32 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType(value)`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/cloudWatch.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/index.md similarity index 66% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/cloudWatch.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/index.md index 340899f..36cc721 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/cloudWatch.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/cloudWatch/index.md @@ -2,6 +2,13 @@ grafonnet.query.cloudWatch +## Subpackages + +* [CloudWatchLogsQuery.logGroups](CloudWatchLogsQuery/logGroups.md) +* [CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters](CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md) +* [CloudWatchMetricsQuery.sql.orderBy.parameters](CloudWatchMetricsQuery/sql/orderBy/parameters.md) +* [CloudWatchMetricsQuery.sql.select.parameters](CloudWatchMetricsQuery/sql/select/parameters.md) + ## Index * [`obj CloudWatchAnnotationQuery`](#obj-cloudwatchannotationquery) @@ -11,12 +18,12 @@ grafonnet.query.cloudWatch * [`fn withDatasource(value)`](#fn-cloudwatchannotationquerywithdatasource) * [`fn withDimensions(value)`](#fn-cloudwatchannotationquerywithdimensions) * [`fn withDimensionsMixin(value)`](#fn-cloudwatchannotationquerywithdimensionsmixin) - * [`fn withHide(value)`](#fn-cloudwatchannotationquerywithhide) - * [`fn withMatchExact(value)`](#fn-cloudwatchannotationquerywithmatchexact) + * [`fn withHide(value=true)`](#fn-cloudwatchannotationquerywithhide) + * [`fn withMatchExact(value=true)`](#fn-cloudwatchannotationquerywithmatchexact) * [`fn withMetricName(value)`](#fn-cloudwatchannotationquerywithmetricname) * [`fn withNamespace(value)`](#fn-cloudwatchannotationquerywithnamespace) * [`fn withPeriod(value)`](#fn-cloudwatchannotationquerywithperiod) - * [`fn withPrefixMatching(value)`](#fn-cloudwatchannotationquerywithprefixmatching) + * [`fn withPrefixMatching(value=true)`](#fn-cloudwatchannotationquerywithprefixmatching) * [`fn withQueryMode(value)`](#fn-cloudwatchannotationquerywithquerymode) * [`fn withQueryType(value)`](#fn-cloudwatchannotationquerywithquerytype) * [`fn withRefId(value)`](#fn-cloudwatchannotationquerywithrefid) @@ -27,7 +34,7 @@ grafonnet.query.cloudWatch * [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) - * [`fn withHide(value)`](#fn-cloudwatchlogsquerywithhide) + * [`fn withHide(value=true)`](#fn-cloudwatchlogsquerywithhide) * [`fn withId(value)`](#fn-cloudwatchlogsquerywithid) * [`fn withLogGroupNames(value)`](#fn-cloudwatchlogsquerywithloggroupnames) * [`fn withLogGroupNamesMixin(value)`](#fn-cloudwatchlogsquerywithloggroupnamesmixin) @@ -39,11 +46,6 @@ grafonnet.query.cloudWatch * [`fn withRegion(value)`](#fn-cloudwatchlogsquerywithregion) * [`fn withStatsGroups(value)`](#fn-cloudwatchlogsquerywithstatsgroups) * [`fn withStatsGroupsMixin(value)`](#fn-cloudwatchlogsquerywithstatsgroupsmixin) - * [`obj logGroups`](#obj-cloudwatchlogsqueryloggroups) - * [`fn withAccountId(value)`](#fn-cloudwatchlogsqueryloggroupswithaccountid) - * [`fn withAccountLabel(value)`](#fn-cloudwatchlogsqueryloggroupswithaccountlabel) - * [`fn withArn(value)`](#fn-cloudwatchlogsqueryloggroupswitharn) - * [`fn withName(value)`](#fn-cloudwatchlogsqueryloggroupswithname) * [`obj CloudWatchMetricsQuery`](#obj-cloudwatchmetricsquery) * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) @@ -51,10 +53,10 @@ grafonnet.query.cloudWatch * [`fn withDimensions(value)`](#fn-cloudwatchmetricsquerywithdimensions) * [`fn withDimensionsMixin(value)`](#fn-cloudwatchmetricsquerywithdimensionsmixin) * [`fn withExpression(value)`](#fn-cloudwatchmetricsquerywithexpression) - * [`fn withHide(value)`](#fn-cloudwatchmetricsquerywithhide) + * [`fn withHide(value=true)`](#fn-cloudwatchmetricsquerywithhide) * [`fn withId(value)`](#fn-cloudwatchmetricsquerywithid) * [`fn withLabel(value)`](#fn-cloudwatchmetricsquerywithlabel) - * [`fn withMatchExact(value)`](#fn-cloudwatchmetricsquerywithmatchexact) + * [`fn withMatchExact(value=true)`](#fn-cloudwatchmetricsquerywithmatchexact) * [`fn withMetricEditorMode(value)`](#fn-cloudwatchmetricsquerywithmetriceditormode) * [`fn withMetricName(value)`](#fn-cloudwatchmetricsquerywithmetricname) * [`fn withMetricQueryType(value)`](#fn-cloudwatchmetricsquerywithmetricquerytype) @@ -93,9 +95,6 @@ grafonnet.query.cloudWatch * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparameters) * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparametersmixin) * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithtype) - * [`obj parameters`](#obj-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionparameters) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionparameterswithname) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionparameterswithtype) * [`obj QueryEditorPropertyExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpression) * [`fn withProperty(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithproperty) * [`fn withPropertyMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithpropertymixin) @@ -112,17 +111,11 @@ grafonnet.query.cloudWatch * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparameters) * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparametersmixin) * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlorderbywithtype) - * [`obj parameters`](#obj-cloudwatchmetricsquerysqlorderbyparameters) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlorderbyparameterswithname) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlorderbyparameterswithtype) * [`obj select`](#obj-cloudwatchmetricsquerysqlselect) * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlselectwithname) * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlselectwithparameters) * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlselectwithparametersmixin) * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlselectwithtype) - * [`obj parameters`](#obj-cloudwatchmetricsquerysqlselectparameters) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlselectparameterswithname) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlselectparameterswithtype) * [`obj where`](#obj-cloudwatchmetricsquerysqlwhere) * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressions) * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressionsmixin) @@ -135,647 +128,823 @@ grafonnet.query.cloudWatch #### fn CloudWatchAnnotationQuery.withAccountId -```ts -withAccountId(value) +```jsonnet +CloudWatchAnnotationQuery.withAccountId(value) ``` -The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. +PARAMETERS: + +* **value** (`string`) +The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. #### fn CloudWatchAnnotationQuery.withActionPrefix -```ts -withActionPrefix(value) +```jsonnet +CloudWatchAnnotationQuery.withActionPrefix(value) ``` +PARAMETERS: + +* **value** (`string`) + Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic. e.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action` but not match `arn:aws:sns:us-east-1:123456789012:your-app-action` - #### fn CloudWatchAnnotationQuery.withAlarmNamePrefix -```ts -withAlarmNamePrefix(value) +```jsonnet +CloudWatchAnnotationQuery.withAlarmNamePrefix(value) ``` +PARAMETERS: + +* **value** (`string`) + An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix. e.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu` - #### fn CloudWatchAnnotationQuery.withDatasource -```ts -withDatasource(value) +```jsonnet +CloudWatchAnnotationQuery.withDatasource(value) ``` +PARAMETERS: + +* **value** (`string`) + For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null - #### fn CloudWatchAnnotationQuery.withDimensions -```ts -withDimensions(value) +```jsonnet +CloudWatchAnnotationQuery.withDimensions(value) ``` -A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +PARAMETERS: + +* **value** (`object`) +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. #### fn CloudWatchAnnotationQuery.withDimensionsMixin -```ts -withDimensionsMixin(value) +```jsonnet +CloudWatchAnnotationQuery.withDimensionsMixin(value) ``` -A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +PARAMETERS: +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. #### fn CloudWatchAnnotationQuery.withHide -```ts -withHide(value) +```jsonnet +CloudWatchAnnotationQuery.withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - #### fn CloudWatchAnnotationQuery.withMatchExact -```ts -withMatchExact(value) +```jsonnet +CloudWatchAnnotationQuery.withMatchExact(value=true) ``` -Only show metrics that exactly match all defined dimension names. +PARAMETERS: +* **value** (`boolean`) + - default value: `true` + +Only show metrics that exactly match all defined dimension names. #### fn CloudWatchAnnotationQuery.withMetricName -```ts -withMetricName(value) +```jsonnet +CloudWatchAnnotationQuery.withMetricName(value) ``` -Name of the metric +PARAMETERS: + +* **value** (`string`) +Name of the metric #### fn CloudWatchAnnotationQuery.withNamespace -```ts -withNamespace(value) +```jsonnet +CloudWatchAnnotationQuery.withNamespace(value) ``` -A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. +PARAMETERS: + +* **value** (`string`) +A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. #### fn CloudWatchAnnotationQuery.withPeriod -```ts -withPeriod(value) +```jsonnet +CloudWatchAnnotationQuery.withPeriod(value) ``` -The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes +PARAMETERS: +* **value** (`string`) + +The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes #### fn CloudWatchAnnotationQuery.withPrefixMatching -```ts -withPrefixMatching(value) +```jsonnet +CloudWatchAnnotationQuery.withPrefixMatching(value=true) ``` -Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix #### fn CloudWatchAnnotationQuery.withQueryMode -```ts -withQueryMode(value) +```jsonnet +CloudWatchAnnotationQuery.withQueryMode(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` -Accepted values for `value` are "Metrics", "Logs", "Annotations" #### fn CloudWatchAnnotationQuery.withQueryType -```ts -withQueryType(value) +```jsonnet +CloudWatchAnnotationQuery.withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - #### fn CloudWatchAnnotationQuery.withRefId -```ts -withRefId(value) +```jsonnet +CloudWatchAnnotationQuery.withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful. - #### fn CloudWatchAnnotationQuery.withRegion -```ts -withRegion(value) +```jsonnet +CloudWatchAnnotationQuery.withRegion(value) ``` -AWS region to query for the metric +PARAMETERS: + +* **value** (`string`) +AWS region to query for the metric #### fn CloudWatchAnnotationQuery.withStatistic -```ts -withStatistic(value) +```jsonnet +CloudWatchAnnotationQuery.withStatistic(value) ``` -Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. +PARAMETERS: +* **value** (`string`) + +Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. #### fn CloudWatchAnnotationQuery.withStatistics -```ts -withStatistics(value) +```jsonnet +CloudWatchAnnotationQuery.withStatistics(value) ``` -@deprecated use statistic +PARAMETERS: + +* **value** (`array`) +@deprecated use statistic #### fn CloudWatchAnnotationQuery.withStatisticsMixin -```ts -withStatisticsMixin(value) +```jsonnet +CloudWatchAnnotationQuery.withStatisticsMixin(value) ``` -@deprecated use statistic +PARAMETERS: +* **value** (`array`) + +@deprecated use statistic ### obj CloudWatchLogsQuery #### fn CloudWatchLogsQuery.withDatasource -```ts -withDatasource(value) +```jsonnet +CloudWatchLogsQuery.withDatasource(value) ``` +PARAMETERS: + +* **value** (`string`) + For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null - #### fn CloudWatchLogsQuery.withExpression -```ts -withExpression(value) +```jsonnet +CloudWatchLogsQuery.withExpression(value) ``` -The CloudWatch Logs Insights query to execute +PARAMETERS: + +* **value** (`string`) +The CloudWatch Logs Insights query to execute #### fn CloudWatchLogsQuery.withHide -```ts -withHide(value) +```jsonnet +CloudWatchLogsQuery.withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - #### fn CloudWatchLogsQuery.withId -```ts -withId(value) +```jsonnet +CloudWatchLogsQuery.withId(value) ``` +PARAMETERS: + +* **value** (`string`) #### fn CloudWatchLogsQuery.withLogGroupNames -```ts -withLogGroupNames(value) +```jsonnet +CloudWatchLogsQuery.withLogGroupNames(value) ``` -@deprecated use logGroups +PARAMETERS: +* **value** (`array`) + +@deprecated use logGroups #### fn CloudWatchLogsQuery.withLogGroupNamesMixin -```ts -withLogGroupNamesMixin(value) +```jsonnet +CloudWatchLogsQuery.withLogGroupNamesMixin(value) ``` -@deprecated use logGroups +PARAMETERS: + +* **value** (`array`) +@deprecated use logGroups #### fn CloudWatchLogsQuery.withLogGroups -```ts -withLogGroups(value) +```jsonnet +CloudWatchLogsQuery.withLogGroups(value) ``` -Log groups to query +PARAMETERS: +* **value** (`array`) + +Log groups to query #### fn CloudWatchLogsQuery.withLogGroupsMixin -```ts -withLogGroupsMixin(value) +```jsonnet +CloudWatchLogsQuery.withLogGroupsMixin(value) ``` -Log groups to query +PARAMETERS: + +* **value** (`array`) +Log groups to query #### fn CloudWatchLogsQuery.withQueryMode -```ts -withQueryMode(value) +```jsonnet +CloudWatchLogsQuery.withQueryMode(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` -Accepted values for `value` are "Metrics", "Logs", "Annotations" #### fn CloudWatchLogsQuery.withQueryType -```ts -withQueryType(value) +```jsonnet +CloudWatchLogsQuery.withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - #### fn CloudWatchLogsQuery.withRefId -```ts -withRefId(value) +```jsonnet +CloudWatchLogsQuery.withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful. - #### fn CloudWatchLogsQuery.withRegion -```ts -withRegion(value) +```jsonnet +CloudWatchLogsQuery.withRegion(value) ``` -AWS region to query for the logs +PARAMETERS: +* **value** (`string`) + +AWS region to query for the logs #### fn CloudWatchLogsQuery.withStatsGroups -```ts -withStatsGroups(value) +```jsonnet +CloudWatchLogsQuery.withStatsGroups(value) ``` -Fields to group the results by, this field is automatically populated whenever the query is updated +PARAMETERS: -#### fn CloudWatchLogsQuery.withStatsGroupsMixin - -```ts -withStatsGroupsMixin(value) -``` +* **value** (`array`) Fields to group the results by, this field is automatically populated whenever the query is updated +#### fn CloudWatchLogsQuery.withStatsGroupsMixin -#### obj CloudWatchLogsQuery.logGroups - - -##### fn CloudWatchLogsQuery.logGroups.withAccountId - -```ts -withAccountId(value) -``` - -AccountId of the log group - -##### fn CloudWatchLogsQuery.logGroups.withAccountLabel - -```ts -withAccountLabel(value) -``` - -Label of the log group - -##### fn CloudWatchLogsQuery.logGroups.withArn - -```ts -withArn(value) +```jsonnet +CloudWatchLogsQuery.withStatsGroupsMixin(value) ``` -ARN of the log group +PARAMETERS: -##### fn CloudWatchLogsQuery.logGroups.withName - -```ts -withName(value) -``` - -Name of the log group +* **value** (`array`) +Fields to group the results by, this field is automatically populated whenever the query is updated ### obj CloudWatchMetricsQuery #### fn CloudWatchMetricsQuery.withAccountId -```ts -withAccountId(value) +```jsonnet +CloudWatchMetricsQuery.withAccountId(value) ``` -The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. +PARAMETERS: + +* **value** (`string`) +The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. #### fn CloudWatchMetricsQuery.withAlias -```ts -withAlias(value) +```jsonnet +CloudWatchMetricsQuery.withAlias(value) ``` +PARAMETERS: + +* **value** (`string`) + Deprecated: use label @deprecated use label - #### fn CloudWatchMetricsQuery.withDatasource -```ts -withDatasource(value) +```jsonnet +CloudWatchMetricsQuery.withDatasource(value) ``` +PARAMETERS: + +* **value** (`string`) + For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null - #### fn CloudWatchMetricsQuery.withDimensions -```ts -withDimensions(value) +```jsonnet +CloudWatchMetricsQuery.withDimensions(value) ``` -A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +PARAMETERS: +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. #### fn CloudWatchMetricsQuery.withDimensionsMixin -```ts -withDimensionsMixin(value) +```jsonnet +CloudWatchMetricsQuery.withDimensionsMixin(value) ``` -A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +PARAMETERS: + +* **value** (`object`) +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. #### fn CloudWatchMetricsQuery.withExpression -```ts -withExpression(value) +```jsonnet +CloudWatchMetricsQuery.withExpression(value) ``` -Math expression query +PARAMETERS: + +* **value** (`string`) +Math expression query #### fn CloudWatchMetricsQuery.withHide -```ts -withHide(value) +```jsonnet +CloudWatchMetricsQuery.withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - #### fn CloudWatchMetricsQuery.withId -```ts -withId(value) +```jsonnet +CloudWatchMetricsQuery.withId(value) ``` -ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter. +PARAMETERS: + +* **value** (`string`) +ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter. #### fn CloudWatchMetricsQuery.withLabel -```ts -withLabel(value) +```jsonnet +CloudWatchMetricsQuery.withLabel(value) ``` -Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details. +PARAMETERS: +* **value** (`string`) + +Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details. #### fn CloudWatchMetricsQuery.withMatchExact -```ts -withMatchExact(value) +```jsonnet +CloudWatchMetricsQuery.withMatchExact(value=true) ``` -Only show metrics that exactly match all defined dimension names. +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +Only show metrics that exactly match all defined dimension names. #### fn CloudWatchMetricsQuery.withMetricEditorMode -```ts -withMetricEditorMode(value) +```jsonnet +CloudWatchMetricsQuery.withMetricEditorMode(value) ``` +PARAMETERS: +* **value** (`integer`) + - valid values: `0`, `1` -Accepted values for `value` are 0, 1 #### fn CloudWatchMetricsQuery.withMetricName -```ts -withMetricName(value) +```jsonnet +CloudWatchMetricsQuery.withMetricName(value) ``` -Name of the metric +PARAMETERS: +* **value** (`string`) + +Name of the metric #### fn CloudWatchMetricsQuery.withMetricQueryType -```ts -withMetricQueryType(value) +```jsonnet +CloudWatchMetricsQuery.withMetricQueryType(value) ``` +PARAMETERS: +* **value** (`integer`) + - valid values: `0`, `1` -Accepted values for `value` are 0, 1 #### fn CloudWatchMetricsQuery.withNamespace -```ts -withNamespace(value) +```jsonnet +CloudWatchMetricsQuery.withNamespace(value) ``` -A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. +PARAMETERS: + +* **value** (`string`) +A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. #### fn CloudWatchMetricsQuery.withPeriod -```ts -withPeriod(value) +```jsonnet +CloudWatchMetricsQuery.withPeriod(value) ``` -The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes +PARAMETERS: +* **value** (`string`) + +The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes #### fn CloudWatchMetricsQuery.withQueryMode -```ts -withQueryMode(value) +```jsonnet +CloudWatchMetricsQuery.withQueryMode(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` -Accepted values for `value` are "Metrics", "Logs", "Annotations" #### fn CloudWatchMetricsQuery.withQueryType -```ts -withQueryType(value) +```jsonnet +CloudWatchMetricsQuery.withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - #### fn CloudWatchMetricsQuery.withRefId -```ts -withRefId(value) +```jsonnet +CloudWatchMetricsQuery.withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful. - #### fn CloudWatchMetricsQuery.withRegion -```ts -withRegion(value) +```jsonnet +CloudWatchMetricsQuery.withRegion(value) ``` -AWS region to query for the metric +PARAMETERS: +* **value** (`string`) + +AWS region to query for the metric #### fn CloudWatchMetricsQuery.withSql -```ts -withSql(value) +```jsonnet +CloudWatchMetricsQuery.withSql(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn CloudWatchMetricsQuery.withSqlExpression -```ts -withSqlExpression(value) +```jsonnet +CloudWatchMetricsQuery.withSqlExpression(value) ``` -When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string. +PARAMETERS: +* **value** (`string`) + +When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string. #### fn CloudWatchMetricsQuery.withSqlMixin -```ts -withSqlMixin(value) +```jsonnet +CloudWatchMetricsQuery.withSqlMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn CloudWatchMetricsQuery.withStatistic -```ts -withStatistic(value) +```jsonnet +CloudWatchMetricsQuery.withStatistic(value) ``` -Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. +PARAMETERS: +* **value** (`string`) + +Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. #### fn CloudWatchMetricsQuery.withStatistics -```ts -withStatistics(value) +```jsonnet +CloudWatchMetricsQuery.withStatistics(value) ``` -@deprecated use statistic +PARAMETERS: + +* **value** (`array`) +@deprecated use statistic #### fn CloudWatchMetricsQuery.withStatisticsMixin -```ts -withStatisticsMixin(value) +```jsonnet +CloudWatchMetricsQuery.withStatisticsMixin(value) ``` -@deprecated use statistic +PARAMETERS: + +* **value** (`array`) +@deprecated use statistic #### obj CloudWatchMetricsQuery.sql ##### fn CloudWatchMetricsQuery.sql.withFrom -```ts -withFrom(value) +```jsonnet +CloudWatchMetricsQuery.sql.withFrom(value) ``` -FROM part of the SQL expression +PARAMETERS: +* **value** (`object`) + +FROM part of the SQL expression ##### fn CloudWatchMetricsQuery.sql.withFromMixin -```ts -withFromMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.withFromMixin(value) ``` -FROM part of the SQL expression +PARAMETERS: + +* **value** (`object`) +FROM part of the SQL expression ##### fn CloudWatchMetricsQuery.sql.withGroupBy -```ts -withGroupBy(value) +```jsonnet +CloudWatchMetricsQuery.sql.withGroupBy(value) ``` +PARAMETERS: + +* **value** (`object`) ##### fn CloudWatchMetricsQuery.sql.withGroupByMixin -```ts -withGroupByMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.withGroupByMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ##### fn CloudWatchMetricsQuery.sql.withLimit -```ts -withLimit(value) +```jsonnet +CloudWatchMetricsQuery.sql.withLimit(value) ``` -LIMIT part of the SQL expression +PARAMETERS: +* **value** (`integer`) + +LIMIT part of the SQL expression ##### fn CloudWatchMetricsQuery.sql.withOrderBy -```ts -withOrderBy(value) +```jsonnet +CloudWatchMetricsQuery.sql.withOrderBy(value) ``` +PARAMETERS: + +* **value** (`object`) ##### fn CloudWatchMetricsQuery.sql.withOrderByDirection -```ts -withOrderByDirection(value) +```jsonnet +CloudWatchMetricsQuery.sql.withOrderByDirection(value) ``` -The sort order of the SQL expression, `ASC` or `DESC` +PARAMETERS: + +* **value** (`string`) +The sort order of the SQL expression, `ASC` or `DESC` ##### fn CloudWatchMetricsQuery.sql.withOrderByMixin -```ts -withOrderByMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.withOrderByMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ##### fn CloudWatchMetricsQuery.sql.withSelect -```ts -withSelect(value) +```jsonnet +CloudWatchMetricsQuery.sql.withSelect(value) ``` +PARAMETERS: + +* **value** (`object`) ##### fn CloudWatchMetricsQuery.sql.withSelectMixin -```ts -withSelectMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.withSelectMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ##### fn CloudWatchMetricsQuery.sql.withWhere -```ts -withWhere(value) +```jsonnet +CloudWatchMetricsQuery.sql.withWhere(value) ``` +PARAMETERS: + +* **value** (`object`) ##### fn CloudWatchMetricsQuery.sql.withWhereMixin -```ts -withWhereMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.withWhereMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ##### obj CloudWatchMetricsQuery.sql.from @@ -783,34 +952,46 @@ withWhereMixin(value) ###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression -```ts -withQueryEditorFunctionExpression(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression(value) ``` +PARAMETERS: + +* **value** (`object`) ###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin -```ts -withQueryEditorFunctionExpressionMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression -```ts -withQueryEditorPropertyExpression(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression(value) ``` +PARAMETERS: + +* **value** (`object`) ###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin -```ts -withQueryEditorPropertyExpressionMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ###### obj CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression @@ -818,53 +999,46 @@ withQueryEditorPropertyExpressionMixin(value) ####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName -```ts -withName(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName(value) ``` +PARAMETERS: + +* **value** (`string`) ####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters -```ts -withParameters(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters(value) ``` +PARAMETERS: - -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin - -```ts -withParametersMixin(value) -``` - +* **value** (`array`) -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin -```ts -withType(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin(value) ``` +PARAMETERS: - -####### obj CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters +* **value** (`array`) -######## fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters.withName +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType -```ts -withName(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType(value) ``` +PARAMETERS: - -######## fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters.withType - -```ts -withType(value) -``` - +* **value** (`string`) ###### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression @@ -872,26 +1046,35 @@ withType(value) ####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty -```ts -withProperty(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty(value) ``` +PARAMETERS: + +* **value** (`object`) ####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin -```ts -withPropertyMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType -```ts -withType(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType(value) ``` +PARAMETERS: + +* **value** (`string`) ####### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property @@ -899,103 +1082,109 @@ withType(value) ######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName -```ts -withName(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName(value) ``` +PARAMETERS: + +* **value** (`string`) ######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType -```ts -withType(value) +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"string"` -Accepted values for `value` are "string" ##### obj CloudWatchMetricsQuery.sql.groupBy ###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressions -```ts -withExpressions(value) +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withExpressions(value) ``` +PARAMETERS: + +* **value** (`array`) ###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin -```ts -withExpressionsMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin(value) ``` +PARAMETERS: + +* **value** (`array`) ###### fn CloudWatchMetricsQuery.sql.groupBy.withType -```ts -withType(value) +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withType(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"and"`, `"or"` -Accepted values for `value` are "and", "or" ##### obj CloudWatchMetricsQuery.sql.orderBy ###### fn CloudWatchMetricsQuery.sql.orderBy.withName -```ts -withName(value) +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withName(value) ``` +PARAMETERS: + +* **value** (`string`) ###### fn CloudWatchMetricsQuery.sql.orderBy.withParameters -```ts -withParameters(value) +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withParameters(value) ``` +PARAMETERS: - -###### fn CloudWatchMetricsQuery.sql.orderBy.withParametersMixin - -```ts -withParametersMixin(value) -``` - +* **value** (`array`) -###### fn CloudWatchMetricsQuery.sql.orderBy.withType +###### fn CloudWatchMetricsQuery.sql.orderBy.withParametersMixin -```ts -withType(value) +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withParametersMixin(value) ``` +PARAMETERS: +* **value** (`array`) -###### obj CloudWatchMetricsQuery.sql.orderBy.parameters +###### fn CloudWatchMetricsQuery.sql.orderBy.withType -####### fn CloudWatchMetricsQuery.sql.orderBy.parameters.withName - -```ts -withName(value) +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withType(value) ``` +PARAMETERS: - -####### fn CloudWatchMetricsQuery.sql.orderBy.parameters.withType - -```ts -withType(value) -``` - +* **value** (`string`) ##### obj CloudWatchMetricsQuery.sql.select @@ -1003,53 +1192,46 @@ withType(value) ###### fn CloudWatchMetricsQuery.sql.select.withName -```ts -withName(value) +```jsonnet +CloudWatchMetricsQuery.sql.select.withName(value) ``` +PARAMETERS: + +* **value** (`string`) ###### fn CloudWatchMetricsQuery.sql.select.withParameters -```ts -withParameters(value) +```jsonnet +CloudWatchMetricsQuery.sql.select.withParameters(value) ``` +PARAMETERS: - -###### fn CloudWatchMetricsQuery.sql.select.withParametersMixin - -```ts -withParametersMixin(value) -``` +* **value** (`array`) +###### fn CloudWatchMetricsQuery.sql.select.withParametersMixin -###### fn CloudWatchMetricsQuery.sql.select.withType - -```ts -withType(value) +```jsonnet +CloudWatchMetricsQuery.sql.select.withParametersMixin(value) ``` +PARAMETERS: - -###### obj CloudWatchMetricsQuery.sql.select.parameters +* **value** (`array`) -####### fn CloudWatchMetricsQuery.sql.select.parameters.withName +###### fn CloudWatchMetricsQuery.sql.select.withType -```ts -withName(value) +```jsonnet +CloudWatchMetricsQuery.sql.select.withType(value) ``` +PARAMETERS: - -####### fn CloudWatchMetricsQuery.sql.select.parameters.withType - -```ts -withType(value) -``` - +* **value** (`string`) ##### obj CloudWatchMetricsQuery.sql.where @@ -1057,26 +1239,34 @@ withType(value) ###### fn CloudWatchMetricsQuery.sql.where.withExpressions -```ts -withExpressions(value) +```jsonnet +CloudWatchMetricsQuery.sql.where.withExpressions(value) ``` +PARAMETERS: + +* **value** (`array`) ###### fn CloudWatchMetricsQuery.sql.where.withExpressionsMixin -```ts -withExpressionsMixin(value) +```jsonnet +CloudWatchMetricsQuery.sql.where.withExpressionsMixin(value) ``` +PARAMETERS: + +* **value** (`array`) ###### fn CloudWatchMetricsQuery.sql.where.withType -```ts -withType(value) +```jsonnet +CloudWatchMetricsQuery.sql.where.withType(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"and"`, `"or"` -Accepted values for `value` are "and", "or" diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md new file mode 100644 index 0000000..34d2819 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md @@ -0,0 +1,32 @@ +# filters + + + +## Index + +* [`fn withLabel(value)`](#fn-withlabel) +* [`fn withQuery(value)`](#fn-withquery) + +## Fields + +### fn withLabel + +```jsonnet +withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/bucketAggs/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/bucketAggs/index.md new file mode 100644 index 0000000..07316db --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/bucketAggs/index.md @@ -0,0 +1,585 @@ +# bucketAggs + + + +## Subpackages + +* [Filters.settings.filters](Filters/settings/filters.md) + +## Index + +* [`obj DateHistogram`](#obj-datehistogram) + * [`fn withField(value)`](#fn-datehistogramwithfield) + * [`fn withId(value)`](#fn-datehistogramwithid) + * [`fn withSettings(value)`](#fn-datehistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-datehistogramwithsettingsmixin) + * [`fn withType(value)`](#fn-datehistogramwithtype) + * [`obj settings`](#obj-datehistogramsettings) + * [`fn withInterval(value)`](#fn-datehistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-datehistogramsettingswithmindoccount) + * [`fn withOffset(value)`](#fn-datehistogramsettingswithoffset) + * [`fn withTimeZone(value)`](#fn-datehistogramsettingswithtimezone) + * [`fn withTrimEdges(value)`](#fn-datehistogramsettingswithtrimedges) +* [`obj Filters`](#obj-filters) + * [`fn withId(value)`](#fn-filterswithid) + * [`fn withSettings(value)`](#fn-filterswithsettings) + * [`fn withSettingsMixin(value)`](#fn-filterswithsettingsmixin) + * [`fn withType(value)`](#fn-filterswithtype) + * [`obj settings`](#obj-filterssettings) + * [`fn withFilters(value)`](#fn-filterssettingswithfilters) + * [`fn withFiltersMixin(value)`](#fn-filterssettingswithfiltersmixin) +* [`obj GeoHashGrid`](#obj-geohashgrid) + * [`fn withField(value)`](#fn-geohashgridwithfield) + * [`fn withId(value)`](#fn-geohashgridwithid) + * [`fn withSettings(value)`](#fn-geohashgridwithsettings) + * [`fn withSettingsMixin(value)`](#fn-geohashgridwithsettingsmixin) + * [`fn withType(value)`](#fn-geohashgridwithtype) + * [`obj settings`](#obj-geohashgridsettings) + * [`fn withPrecision(value)`](#fn-geohashgridsettingswithprecision) +* [`obj Histogram`](#obj-histogram) + * [`fn withField(value)`](#fn-histogramwithfield) + * [`fn withId(value)`](#fn-histogramwithid) + * [`fn withSettings(value)`](#fn-histogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-histogramwithsettingsmixin) + * [`fn withType(value)`](#fn-histogramwithtype) + * [`obj settings`](#obj-histogramsettings) + * [`fn withInterval(value)`](#fn-histogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-histogramsettingswithmindoccount) +* [`obj Nested`](#obj-nested) + * [`fn withField(value)`](#fn-nestedwithfield) + * [`fn withId(value)`](#fn-nestedwithid) + * [`fn withSettings(value)`](#fn-nestedwithsettings) + * [`fn withSettingsMixin(value)`](#fn-nestedwithsettingsmixin) + * [`fn withType(value)`](#fn-nestedwithtype) +* [`obj Terms`](#obj-terms) + * [`fn withField(value)`](#fn-termswithfield) + * [`fn withId(value)`](#fn-termswithid) + * [`fn withSettings(value)`](#fn-termswithsettings) + * [`fn withSettingsMixin(value)`](#fn-termswithsettingsmixin) + * [`fn withType(value)`](#fn-termswithtype) + * [`obj settings`](#obj-termssettings) + * [`fn withMinDocCount(value)`](#fn-termssettingswithmindoccount) + * [`fn withMissing(value)`](#fn-termssettingswithmissing) + * [`fn withOrder(value)`](#fn-termssettingswithorder) + * [`fn withOrderBy(value)`](#fn-termssettingswithorderby) + * [`fn withSize(value)`](#fn-termssettingswithsize) + +## Fields + +### obj DateHistogram + + +#### fn DateHistogram.withField + +```jsonnet +DateHistogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withId + +```jsonnet +DateHistogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withSettings + +```jsonnet +DateHistogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withSettingsMixin + +```jsonnet +DateHistogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withType + +```jsonnet +DateHistogram.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj DateHistogram.settings + + +##### fn DateHistogram.settings.withInterval + +```jsonnet +DateHistogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withMinDocCount + +```jsonnet +DateHistogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withOffset + +```jsonnet +DateHistogram.settings.withOffset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTimeZone + +```jsonnet +DateHistogram.settings.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTrimEdges + +```jsonnet +DateHistogram.settings.withTrimEdges(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Filters + + +#### fn Filters.withId + +```jsonnet +Filters.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Filters.withSettings + +```jsonnet +Filters.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withSettingsMixin + +```jsonnet +Filters.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withType + +```jsonnet +Filters.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj Filters.settings + + +##### fn Filters.settings.withFilters + +```jsonnet +Filters.settings.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn Filters.settings.withFiltersMixin + +```jsonnet +Filters.settings.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj GeoHashGrid + + +#### fn GeoHashGrid.withField + +```jsonnet +GeoHashGrid.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withId + +```jsonnet +GeoHashGrid.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withSettings + +```jsonnet +GeoHashGrid.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withSettingsMixin + +```jsonnet +GeoHashGrid.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withType + +```jsonnet +GeoHashGrid.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj GeoHashGrid.settings + + +##### fn GeoHashGrid.settings.withPrecision + +```jsonnet +GeoHashGrid.settings.withPrecision(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Histogram + + +#### fn Histogram.withField + +```jsonnet +Histogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withId + +```jsonnet +Histogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withSettings + +```jsonnet +Histogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withSettingsMixin + +```jsonnet +Histogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withType + +```jsonnet +Histogram.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj Histogram.settings + + +##### fn Histogram.settings.withInterval + +```jsonnet +Histogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Histogram.settings.withMinDocCount + +```jsonnet +Histogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Nested + + +#### fn Nested.withField + +```jsonnet +Nested.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withId + +```jsonnet +Nested.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withSettings + +```jsonnet +Nested.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withSettingsMixin + +```jsonnet +Nested.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withType + +```jsonnet +Nested.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Terms + + +#### fn Terms.withField + +```jsonnet +Terms.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withId + +```jsonnet +Terms.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withSettings + +```jsonnet +Terms.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withSettingsMixin + +```jsonnet +Terms.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withType + +```jsonnet +Terms.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj Terms.settings + + +##### fn Terms.settings.withMinDocCount + +```jsonnet +Terms.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withMissing + +```jsonnet +Terms.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withOrder + +```jsonnet +Terms.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"desc"`, `"asc"` + + +##### fn Terms.settings.withOrderBy + +```jsonnet +Terms.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withSize + +```jsonnet +Terms.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/index.md new file mode 100644 index 0000000..b5926b0 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/index.md @@ -0,0 +1,155 @@ +# elasticsearch + +grafonnet.query.elasticsearch + +## Subpackages + +* [bucketAggs](bucketAggs/index.md) +* [metrics](metrics/index.md) + +## Index + +* [`fn withAlias(value)`](#fn-withalias) +* [`fn withBucketAggs(value)`](#fn-withbucketaggs) +* [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withMetrics(value)`](#fn-withmetrics) +* [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withTimeField(value)`](#fn-withtimefield) + +## Fields + +### fn withAlias + +```jsonnet +withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alias pattern +### fn withBucketAggs + +```jsonnet +withBucketAggs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of bucket aggregations +### fn withBucketAggsMixin + +```jsonnet +withBucketAggsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of bucket aggregations +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +Note this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withMetrics + +```jsonnet +withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of metric aggregations +### fn withMetricsMixin + +```jsonnet +withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of metric aggregations +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Lucene query +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withTimeField + +```jsonnet +withTimeField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of time field \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md new file mode 100644 index 0000000..98f8952 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md @@ -0,0 +1,32 @@ +# pipelineVariables + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPipelineAgg(value)`](#fn-withpipelineagg) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPipelineAgg + +```jsonnet +withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md new file mode 100644 index 0000000..98f8952 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md @@ -0,0 +1,32 @@ +# pipelineVariables + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPipelineAgg(value)`](#fn-withpipelineagg) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPipelineAgg + +```jsonnet +withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/index.md new file mode 100644 index 0000000..60a0291 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/elasticsearch/metrics/index.md @@ -0,0 +1,2616 @@ +# metrics + + + +## Subpackages + +* [MetricAggregationWithSettings.BucketScript.pipelineVariables](MetricAggregationWithSettings/BucketScript/pipelineVariables.md) +* [PipelineMetricAggregation.BucketScript.pipelineVariables](PipelineMetricAggregation/BucketScript/pipelineVariables.md) + +## Index + +* [`obj Count`](#obj-count) + * [`fn withHide(value=true)`](#fn-countwithhide) + * [`fn withId(value)`](#fn-countwithid) + * [`fn withType(value)`](#fn-countwithtype) +* [`obj MetricAggregationWithSettings`](#obj-metricaggregationwithsettings) + * [`obj Average`](#obj-metricaggregationwithsettingsaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsaveragewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsaveragewithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsaveragewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsaveragesettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsaveragesettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsaveragesettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsaveragesettingsscriptwithinline) + * [`obj BucketScript`](#obj-metricaggregationwithsettingsbucketscript) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsbucketscriptwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricaggregationwithsettingscumulativesum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingscumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingscumulativesumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingscumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingscumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingscumulativesumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingscumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricaggregationwithsettingscumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricaggregationwithsettingsderivative) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsderivativewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsderivativewithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsderivativewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsderivativesettings) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsderivativesettingswithunit) + * [`obj ExtendedStats`](#obj-metricaggregationwithsettingsextendedstats) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsextendedstatswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsextendedstatswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsextendedstatswithid) + * [`fn withMeta(value)`](#fn-metricaggregationwithsettingsextendedstatswithmeta) + * [`fn withMetaMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithmetamixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsextendedstatswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsextendedstatssettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscriptmixin) + * [`fn withSigma(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithsigma) + * [`obj script`](#obj-metricaggregationwithsettingsextendedstatssettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsextendedstatssettingsscriptwithinline) + * [`obj Logs`](#obj-metricaggregationwithsettingslogs) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingslogswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingslogswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingslogswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingslogswithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingslogswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingslogssettings) + * [`fn withLimit(value)`](#fn-metricaggregationwithsettingslogssettingswithlimit) + * [`obj Max`](#obj-metricaggregationwithsettingsmax) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmaxwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmaxwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmaxwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmaxwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmaxwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsmaxwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmaxsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsmaxsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsmaxsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmaxsettingsscriptwithinline) + * [`obj Min`](#obj-metricaggregationwithsettingsmin) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsminwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsminwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsminwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsminwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsminwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsminwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsminsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsminsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsminsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsminsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsminsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsminsettingsscriptwithinline) + * [`obj MovingAverage`](#obj-metricaggregationwithsettingsmovingaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsmovingaveragewithtype) + * [`obj MovingFunction`](#obj-metricaggregationwithsettingsmovingfunction) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingfunctionwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmovingfunctionsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) + * [`fn withShift(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithshift) + * [`fn withWindow(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithwindow) + * [`obj script`](#obj-metricaggregationwithsettingsmovingfunctionsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) + * [`obj Percentiles`](#obj-metricaggregationwithsettingspercentiles) + * [`fn withField(value)`](#fn-metricaggregationwithsettingspercentileswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingspercentileswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingspercentileswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingspercentileswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingspercentileswithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingspercentileswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingspercentilessettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingspercentilessettingswithmissing) + * [`fn withPercents(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercents) + * [`fn withPercentsMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercentsmixin) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingspercentilessettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingspercentilessettingsscriptwithinline) + * [`obj Rate`](#obj-metricaggregationwithsettingsrate) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsratewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsratewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsratewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsratewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsratewithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsratewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsratesettings) + * [`fn withMode(value)`](#fn-metricaggregationwithsettingsratesettingswithmode) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsratesettingswithunit) + * [`obj RawData`](#obj-metricaggregationwithsettingsrawdata) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdatawithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdatawithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdatawithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdatawithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsrawdatawithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdatasettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdatasettingswithsize) + * [`obj RawDocument`](#obj-metricaggregationwithsettingsrawdocument) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdocumentwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdocumentwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsrawdocumentwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdocumentsettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdocumentsettingswithsize) + * [`obj SerialDiff`](#obj-metricaggregationwithsettingsserialdiff) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsserialdiffwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsserialdiffwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsserialdiffwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsserialdiffwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsserialdiffwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsserialdiffsettings) + * [`fn withLag(value)`](#fn-metricaggregationwithsettingsserialdiffsettingswithlag) + * [`obj Sum`](#obj-metricaggregationwithsettingssum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingssumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingssumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingssumwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingssumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingssumwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingssumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingssumsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingssumsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingssumsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingssumsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingssumsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingssumsettingsscriptwithinline) + * [`obj TopMetrics`](#obj-metricaggregationwithsettingstopmetrics) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingstopmetricswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingstopmetricswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingstopmetricswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingstopmetricswithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingstopmetricswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingstopmetricssettings) + * [`fn withMetrics(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetrics) + * [`fn withMetricsMixin(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetricsmixin) + * [`fn withOrder(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorder) + * [`fn withOrderBy(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorderby) + * [`obj UniqueCount`](#obj-metricaggregationwithsettingsuniquecount) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsuniquecountwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsuniquecountwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsuniquecountwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettingsmixin) + * [`fn withType(value)`](#fn-metricaggregationwithsettingsuniquecountwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsuniquecountsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithmissing) + * [`fn withPrecisionThreshold(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) +* [`obj PipelineMetricAggregation`](#obj-pipelinemetricaggregation) + * [`obj BucketScript`](#obj-pipelinemetricaggregationbucketscript) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationbucketscriptwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettingsmixin) + * [`fn withType(value)`](#fn-pipelinemetricaggregationbucketscriptwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationbucketscriptsettings) + * [`fn withScript(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-pipelinemetricaggregationbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-pipelinemetricaggregationbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-pipelinemetricaggregationcumulativesum) + * [`fn withField(value)`](#fn-pipelinemetricaggregationcumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationcumulativesumwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationcumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationcumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettingsmixin) + * [`fn withType(value)`](#fn-pipelinemetricaggregationcumulativesumwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationcumulativesumsettings) + * [`fn withFormat(value)`](#fn-pipelinemetricaggregationcumulativesumsettingswithformat) + * [`obj Derivative`](#obj-pipelinemetricaggregationderivative) + * [`fn withField(value)`](#fn-pipelinemetricaggregationderivativewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationderivativewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationderivativewithsettingsmixin) + * [`fn withType(value)`](#fn-pipelinemetricaggregationderivativewithtype) + * [`obj settings`](#obj-pipelinemetricaggregationderivativesettings) + * [`fn withUnit(value)`](#fn-pipelinemetricaggregationderivativesettingswithunit) + * [`obj MovingAverage`](#obj-pipelinemetricaggregationmovingaverage) + * [`fn withField(value)`](#fn-pipelinemetricaggregationmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationmovingaveragewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettingsmixin) + * [`fn withType(value)`](#fn-pipelinemetricaggregationmovingaveragewithtype) + +## Fields + +### obj Count + + +#### fn Count.withHide + +```jsonnet +Count.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn Count.withId + +```jsonnet +Count.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Count.withType + +```jsonnet +Count.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj MetricAggregationWithSettings + + +#### obj MetricAggregationWithSettings.Average + + +##### fn MetricAggregationWithSettings.Average.withField + +```jsonnet +MetricAggregationWithSettings.Average.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withHide + +```jsonnet +MetricAggregationWithSettings.Average.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Average.withId + +```jsonnet +MetricAggregationWithSettings.Average.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withSettings + +```jsonnet +MetricAggregationWithSettings.Average.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Average.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withType + +```jsonnet +MetricAggregationWithSettings.Average.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.Average.settings + + +###### fn MetricAggregationWithSettings.Average.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Average.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Average.settings.script + + +####### fn MetricAggregationWithSettings.Average.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Average.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.BucketScript + + +##### fn MetricAggregationWithSettings.BucketScript.withHide + +```jsonnet +MetricAggregationWithSettings.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.BucketScript.withId + +```jsonnet +MetricAggregationWithSettings.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariables + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettings + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withType + +```jsonnet +MetricAggregationWithSettings.BucketScript.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.BucketScript.settings + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScript + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.BucketScript.settings.script + + +####### fn MetricAggregationWithSettings.BucketScript.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.CumulativeSum + + +##### fn MetricAggregationWithSettings.CumulativeSum.withField + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withHide + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.CumulativeSum.withId + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettings + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withType + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.CumulativeSum.settings + + +###### fn MetricAggregationWithSettings.CumulativeSum.settings.withFormat + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Derivative + + +##### fn MetricAggregationWithSettings.Derivative.withField + +```jsonnet +MetricAggregationWithSettings.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withHide + +```jsonnet +MetricAggregationWithSettings.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Derivative.withId + +```jsonnet +MetricAggregationWithSettings.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettings + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withType + +```jsonnet +MetricAggregationWithSettings.Derivative.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.Derivative.settings + + +###### fn MetricAggregationWithSettings.Derivative.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.ExtendedStats + + +##### fn MetricAggregationWithSettings.ExtendedStats.withField + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withHide + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.ExtendedStats.withId + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMeta + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMetaMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettings + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withType + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.ExtendedStats.settings + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScript + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withSigma + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.ExtendedStats.settings.script + + +####### fn MetricAggregationWithSettings.ExtendedStats.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Logs + + +##### fn MetricAggregationWithSettings.Logs.withHide + +```jsonnet +MetricAggregationWithSettings.Logs.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Logs.withId + +```jsonnet +MetricAggregationWithSettings.Logs.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Logs.withSettings + +```jsonnet +MetricAggregationWithSettings.Logs.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Logs.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withType + +```jsonnet +MetricAggregationWithSettings.Logs.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.Logs.settings + + +###### fn MetricAggregationWithSettings.Logs.settings.withLimit + +```jsonnet +MetricAggregationWithSettings.Logs.settings.withLimit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Max + + +##### fn MetricAggregationWithSettings.Max.withField + +```jsonnet +MetricAggregationWithSettings.Max.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withHide + +```jsonnet +MetricAggregationWithSettings.Max.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Max.withId + +```jsonnet +MetricAggregationWithSettings.Max.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withSettings + +```jsonnet +MetricAggregationWithSettings.Max.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Max.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withType + +```jsonnet +MetricAggregationWithSettings.Max.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.Max.settings + + +###### fn MetricAggregationWithSettings.Max.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Max.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Max.settings.script + + +####### fn MetricAggregationWithSettings.Max.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Max.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Min + + +##### fn MetricAggregationWithSettings.Min.withField + +```jsonnet +MetricAggregationWithSettings.Min.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withHide + +```jsonnet +MetricAggregationWithSettings.Min.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Min.withId + +```jsonnet +MetricAggregationWithSettings.Min.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withSettings + +```jsonnet +MetricAggregationWithSettings.Min.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Min.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withType + +```jsonnet +MetricAggregationWithSettings.Min.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.Min.settings + + +###### fn MetricAggregationWithSettings.Min.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Min.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Min.settings.script + + +####### fn MetricAggregationWithSettings.Min.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Min.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.MovingAverage + + +##### fn MetricAggregationWithSettings.MovingAverage.withField + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withHide + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingAverage.withId + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withType + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.MovingFunction + + +##### fn MetricAggregationWithSettings.MovingFunction.withField + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withHide + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingFunction.withId + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withType + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.MovingFunction.settings + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScript + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withShift + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withWindow + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.MovingFunction.settings.script + + +####### fn MetricAggregationWithSettings.MovingFunction.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Percentiles + + +##### fn MetricAggregationWithSettings.Percentiles.withField + +```jsonnet +MetricAggregationWithSettings.Percentiles.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withHide + +```jsonnet +MetricAggregationWithSettings.Percentiles.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Percentiles.withId + +```jsonnet +MetricAggregationWithSettings.Percentiles.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettings + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withType + +```jsonnet +MetricAggregationWithSettings.Percentiles.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.Percentiles.settings + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercents + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercents(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Percentiles.settings.script + + +####### fn MetricAggregationWithSettings.Percentiles.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Rate + + +##### fn MetricAggregationWithSettings.Rate.withField + +```jsonnet +MetricAggregationWithSettings.Rate.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withHide + +```jsonnet +MetricAggregationWithSettings.Rate.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Rate.withId + +```jsonnet +MetricAggregationWithSettings.Rate.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withSettings + +```jsonnet +MetricAggregationWithSettings.Rate.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Rate.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withType + +```jsonnet +MetricAggregationWithSettings.Rate.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.Rate.settings + + +###### fn MetricAggregationWithSettings.Rate.settings.withMode + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Rate.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawData + + +##### fn MetricAggregationWithSettings.RawData.withHide + +```jsonnet +MetricAggregationWithSettings.RawData.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawData.withId + +```jsonnet +MetricAggregationWithSettings.RawData.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawData.withSettings + +```jsonnet +MetricAggregationWithSettings.RawData.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawData.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withType + +```jsonnet +MetricAggregationWithSettings.RawData.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.RawData.settings + + +###### fn MetricAggregationWithSettings.RawData.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawData.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawDocument + + +##### fn MetricAggregationWithSettings.RawDocument.withHide + +```jsonnet +MetricAggregationWithSettings.RawDocument.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawDocument.withId + +```jsonnet +MetricAggregationWithSettings.RawDocument.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettings + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withType + +```jsonnet +MetricAggregationWithSettings.RawDocument.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.RawDocument.settings + + +###### fn MetricAggregationWithSettings.RawDocument.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawDocument.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.SerialDiff + + +##### fn MetricAggregationWithSettings.SerialDiff.withField + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withHide + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.SerialDiff.withId + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettings + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withType + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.SerialDiff.settings + + +###### fn MetricAggregationWithSettings.SerialDiff.settings.withLag + +```jsonnet +MetricAggregationWithSettings.SerialDiff.settings.withLag(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Sum + + +##### fn MetricAggregationWithSettings.Sum.withField + +```jsonnet +MetricAggregationWithSettings.Sum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withHide + +```jsonnet +MetricAggregationWithSettings.Sum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Sum.withId + +```jsonnet +MetricAggregationWithSettings.Sum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withSettings + +```jsonnet +MetricAggregationWithSettings.Sum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Sum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withType + +```jsonnet +MetricAggregationWithSettings.Sum.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.Sum.settings + + +###### fn MetricAggregationWithSettings.Sum.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Sum.settings.script + + +####### fn MetricAggregationWithSettings.Sum.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Sum.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.TopMetrics + + +##### fn MetricAggregationWithSettings.TopMetrics.withHide + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.TopMetrics.withId + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettings + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withType + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.TopMetrics.settings + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetrics + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrder + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrderBy + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.UniqueCount + + +##### fn MetricAggregationWithSettings.UniqueCount.withField + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withHide + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.UniqueCount.withId + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettings + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withType + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj MetricAggregationWithSettings.UniqueCount.settings + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj PipelineMetricAggregation + + +#### obj PipelineMetricAggregation.BucketScript + + +##### fn PipelineMetricAggregation.BucketScript.withHide + +```jsonnet +PipelineMetricAggregation.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.BucketScript.withId + +```jsonnet +PipelineMetricAggregation.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariables + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettings + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withType + +```jsonnet +PipelineMetricAggregation.BucketScript.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj PipelineMetricAggregation.BucketScript.settings + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScript + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScriptMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj PipelineMetricAggregation.BucketScript.settings.script + + +####### fn PipelineMetricAggregation.BucketScript.settings.script.withInline + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.CumulativeSum + + +##### fn PipelineMetricAggregation.CumulativeSum.withField + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withHide + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.CumulativeSum.withId + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettings + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withType + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj PipelineMetricAggregation.CumulativeSum.settings + + +###### fn PipelineMetricAggregation.CumulativeSum.settings.withFormat + +```jsonnet +PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.Derivative + + +##### fn PipelineMetricAggregation.Derivative.withField + +```jsonnet +PipelineMetricAggregation.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withHide + +```jsonnet +PipelineMetricAggregation.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.Derivative.withId + +```jsonnet +PipelineMetricAggregation.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withSettings + +```jsonnet +PipelineMetricAggregation.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withType + +```jsonnet +PipelineMetricAggregation.Derivative.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj PipelineMetricAggregation.Derivative.settings + + +###### fn PipelineMetricAggregation.Derivative.settings.withUnit + +```jsonnet +PipelineMetricAggregation.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.MovingAverage + + +##### fn PipelineMetricAggregation.MovingAverage.withField + +```jsonnet +PipelineMetricAggregation.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withHide + +```jsonnet +PipelineMetricAggregation.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.MovingAverage.withId + +```jsonnet +PipelineMetricAggregation.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettings + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withType + +```jsonnet +PipelineMetricAggregation.MovingAverage.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/googleCloudMonitoring.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/googleCloudMonitoring.md new file mode 100644 index 0000000..7b82b66 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/googleCloudMonitoring.md @@ -0,0 +1,599 @@ +# googleCloudMonitoring + +grafonnet.query.googleCloudMonitoring + +## Index + +* [`fn withAliasBy(value)`](#fn-withaliasby) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withPromQLQuery(value)`](#fn-withpromqlquery) +* [`fn withPromQLQueryMixin(value)`](#fn-withpromqlquerymixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSloQuery(value)`](#fn-withsloquery) +* [`fn withSloQueryMixin(value)`](#fn-withsloquerymixin) +* [`fn withTimeSeriesList(value)`](#fn-withtimeserieslist) +* [`fn withTimeSeriesListMixin(value)`](#fn-withtimeserieslistmixin) +* [`fn withTimeSeriesQuery(value)`](#fn-withtimeseriesquery) +* [`fn withTimeSeriesQueryMixin(value)`](#fn-withtimeseriesquerymixin) +* [`obj promQLQuery`](#obj-promqlquery) + * [`fn withExpr(value)`](#fn-promqlquerywithexpr) + * [`fn withProjectName(value)`](#fn-promqlquerywithprojectname) + * [`fn withStep(value)`](#fn-promqlquerywithstep) +* [`obj sloQuery`](#obj-sloquery) + * [`fn withAlignmentPeriod(value)`](#fn-sloquerywithalignmentperiod) + * [`fn withGoal(value)`](#fn-sloquerywithgoal) + * [`fn withLookbackPeriod(value)`](#fn-sloquerywithlookbackperiod) + * [`fn withPerSeriesAligner(value)`](#fn-sloquerywithperseriesaligner) + * [`fn withProjectName(value)`](#fn-sloquerywithprojectname) + * [`fn withSelectorName(value)`](#fn-sloquerywithselectorname) + * [`fn withServiceId(value)`](#fn-sloquerywithserviceid) + * [`fn withServiceName(value)`](#fn-sloquerywithservicename) + * [`fn withSloId(value)`](#fn-sloquerywithsloid) + * [`fn withSloName(value)`](#fn-sloquerywithsloname) +* [`obj timeSeriesList`](#obj-timeserieslist) + * [`fn withAlignmentPeriod(value)`](#fn-timeserieslistwithalignmentperiod) + * [`fn withCrossSeriesReducer(value)`](#fn-timeserieslistwithcrossseriesreducer) + * [`fn withFilters(value)`](#fn-timeserieslistwithfilters) + * [`fn withFiltersMixin(value)`](#fn-timeserieslistwithfiltersmixin) + * [`fn withGroupBys(value)`](#fn-timeserieslistwithgroupbys) + * [`fn withGroupBysMixin(value)`](#fn-timeserieslistwithgroupbysmixin) + * [`fn withPerSeriesAligner(value)`](#fn-timeserieslistwithperseriesaligner) + * [`fn withPreprocessor(value)`](#fn-timeserieslistwithpreprocessor) + * [`fn withProjectName(value)`](#fn-timeserieslistwithprojectname) + * [`fn withSecondaryAlignmentPeriod(value)`](#fn-timeserieslistwithsecondaryalignmentperiod) + * [`fn withSecondaryCrossSeriesReducer(value)`](#fn-timeserieslistwithsecondarycrossseriesreducer) + * [`fn withSecondaryGroupBys(value)`](#fn-timeserieslistwithsecondarygroupbys) + * [`fn withSecondaryGroupBysMixin(value)`](#fn-timeserieslistwithsecondarygroupbysmixin) + * [`fn withSecondaryPerSeriesAligner(value)`](#fn-timeserieslistwithsecondaryperseriesaligner) + * [`fn withText(value)`](#fn-timeserieslistwithtext) + * [`fn withTitle(value)`](#fn-timeserieslistwithtitle) + * [`fn withView(value)`](#fn-timeserieslistwithview) +* [`obj timeSeriesQuery`](#obj-timeseriesquery) + * [`fn withGraphPeriod(value)`](#fn-timeseriesquerywithgraphperiod) + * [`fn withProjectName(value)`](#fn-timeseriesquerywithprojectname) + * [`fn withQuery(value)`](#fn-timeseriesquerywithquery) + +## Fields + +### fn withAliasBy + +```jsonnet +withAliasBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +Note this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Time interval in milliseconds. +### fn withPromQLQuery + +```jsonnet +withPromQLQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +PromQL sub-query properties. +### fn withPromQLQueryMixin + +```jsonnet +withPromQLQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +PromQL sub-query properties. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSloQuery + +```jsonnet +withSloQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SLO sub-query properties. +### fn withSloQueryMixin + +```jsonnet +withSloQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SLO sub-query properties. +### fn withTimeSeriesList + +```jsonnet +withTimeSeriesList(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series List sub-query properties. +### fn withTimeSeriesListMixin + +```jsonnet +withTimeSeriesListMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series List sub-query properties. +### fn withTimeSeriesQuery + +```jsonnet +withTimeSeriesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series sub-query properties. +### fn withTimeSeriesQueryMixin + +```jsonnet +withTimeSeriesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series sub-query properties. +### obj promQLQuery + + +#### fn promQLQuery.withExpr + +```jsonnet +promQLQuery.withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + +PromQL expression/query to be executed. +#### fn promQLQuery.withProjectName + +```jsonnet +promQLQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn promQLQuery.withStep + +```jsonnet +promQLQuery.withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + +PromQL min step +### obj sloQuery + + +#### fn sloQuery.withAlignmentPeriod + +```jsonnet +sloQuery.withAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn sloQuery.withGoal + +```jsonnet +sloQuery.withGoal(value) +``` + +PARAMETERS: + +* **value** (`number`) + +SLO goal value. +#### fn sloQuery.withLookbackPeriod + +```jsonnet +sloQuery.withLookbackPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific lookback period for the SLO. +#### fn sloQuery.withPerSeriesAligner + +```jsonnet +sloQuery.withPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn sloQuery.withProjectName + +```jsonnet +sloQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn sloQuery.withSelectorName + +```jsonnet +sloQuery.withSelectorName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +SLO selector. +#### fn sloQuery.withServiceId + +```jsonnet +sloQuery.withServiceId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID for the service the SLO is in. +#### fn sloQuery.withServiceName + +```jsonnet +sloQuery.withServiceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name for the service the SLO is in. +#### fn sloQuery.withSloId + +```jsonnet +sloQuery.withSloId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID for the SLO. +#### fn sloQuery.withSloName + +```jsonnet +sloQuery.withSloName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the SLO. +### obj timeSeriesList + + +#### fn timeSeriesList.withAlignmentPeriod + +```jsonnet +timeSeriesList.withAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn timeSeriesList.withCrossSeriesReducer + +```jsonnet +timeSeriesList.withCrossSeriesReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reducer applied across a set of time-series values. Defaults to REDUCE_NONE. +#### fn timeSeriesList.withFilters + +```jsonnet +timeSeriesList.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of filters to query data by. Labels that can be filtered on are defined by the metric. +#### fn timeSeriesList.withFiltersMixin + +```jsonnet +timeSeriesList.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of filters to query data by. Labels that can be filtered on are defined by the metric. +#### fn timeSeriesList.withGroupBys + +```jsonnet +timeSeriesList.withGroupBys(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of labels to group data by. +#### fn timeSeriesList.withGroupBysMixin + +```jsonnet +timeSeriesList.withGroupBysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of labels to group data by. +#### fn timeSeriesList.withPerSeriesAligner + +```jsonnet +timeSeriesList.withPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn timeSeriesList.withPreprocessor + +```jsonnet +timeSeriesList.withPreprocessor(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"rate"`, `"delta"` + +Types of pre-processor available. Defined by the metric. +#### fn timeSeriesList.withProjectName + +```jsonnet +timeSeriesList.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn timeSeriesList.withSecondaryAlignmentPeriod + +```jsonnet +timeSeriesList.withSecondaryAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn timeSeriesList.withSecondaryCrossSeriesReducer + +```jsonnet +timeSeriesList.withSecondaryCrossSeriesReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE. +#### fn timeSeriesList.withSecondaryGroupBys + +```jsonnet +timeSeriesList.withSecondaryGroupBys(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only present if a preprocessor is selected. Array of labels to group data by. +#### fn timeSeriesList.withSecondaryGroupBysMixin + +```jsonnet +timeSeriesList.withSecondaryGroupBysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only present if a preprocessor is selected. Array of labels to group data by. +#### fn timeSeriesList.withSecondaryPerSeriesAligner + +```jsonnet +timeSeriesList.withSecondaryPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn timeSeriesList.withText + +```jsonnet +timeSeriesList.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Annotation text. +#### fn timeSeriesList.withTitle + +```jsonnet +timeSeriesList.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Annotation title. +#### fn timeSeriesList.withView + +```jsonnet +timeSeriesList.withView(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Data view, defaults to FULL. +### obj timeSeriesQuery + + +#### fn timeSeriesQuery.withGraphPeriod + +```jsonnet +timeSeriesQuery.withGraphPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +To disable the graphPeriod, it should explictly be set to 'disabled'. +#### fn timeSeriesQuery.withProjectName + +```jsonnet +timeSeriesQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn timeSeriesQuery.withQuery + +```jsonnet +timeSeriesQuery.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +MQL query to be executed. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/grafanaPyroscope.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/grafanaPyroscope.md similarity index 76% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/grafanaPyroscope.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/grafanaPyroscope.md index 3436973..69779d9 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/grafanaPyroscope.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/grafanaPyroscope.md @@ -7,7 +7,7 @@ grafonnet.query.grafanaPyroscope * [`fn withDatasource(value)`](#fn-withdatasource) * [`fn withGroupBy(value)`](#fn-withgroupby) * [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) -* [`fn withHide(value)`](#fn-withhide) +* [`fn withHide(value=true)`](#fn-withhide) * [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) * [`fn withMaxNodes(value)`](#fn-withmaxnodes) * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) @@ -18,80 +18,110 @@ grafonnet.query.grafanaPyroscope ### fn withDatasource -```ts +```jsonnet withDatasource(value) ``` +PARAMETERS: + +* **value** (`string`) + For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null - ### fn withGroupBy -```ts +```jsonnet withGroupBy(value) ``` -Allows to group the results. +PARAMETERS: +* **value** (`array`) + +Allows to group the results. ### fn withGroupByMixin -```ts +```jsonnet withGroupByMixin(value) ``` -Allows to group the results. +PARAMETERS: +* **value** (`array`) + +Allows to group the results. ### fn withHide -```ts -withHide(value) +```jsonnet +withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - ### fn withLabelSelector -```ts +```jsonnet withLabelSelector(value="{}") ``` -Specifies the query label selectors. +PARAMETERS: +* **value** (`string`) + - default value: `"{}"` + +Specifies the query label selectors. ### fn withMaxNodes -```ts +```jsonnet withMaxNodes(value) ``` -Sets the maximum number of nodes in the flamegraph. +PARAMETERS: + +* **value** (`integer`) +Sets the maximum number of nodes in the flamegraph. ### fn withProfileTypeId -```ts +```jsonnet withProfileTypeId(value) ``` -Specifies the type of profile to query. +PARAMETERS: + +* **value** (`string`) +Specifies the type of profile to query. ### fn withQueryType -```ts +```jsonnet withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - ### fn withRefId -```ts +```jsonnet withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/index.md new file mode 100644 index 0000000..c36150f --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/index.md @@ -0,0 +1,16 @@ +# query + +grafonnet.query + +## Subpackages + +* [azureMonitor](azureMonitor/index.md) +* [cloudWatch](cloudWatch/index.md) +* [elasticsearch](elasticsearch/index.md) +* [googleCloudMonitoring](googleCloudMonitoring.md) +* [grafanaPyroscope](grafanaPyroscope.md) +* [loki](loki.md) +* [parca](parca.md) +* [prometheus](prometheus.md) +* [tempo](tempo/index.md) +* [testData](testData/index.md) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/loki.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/loki.md similarity index 61% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/loki.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/loki.md index 5a048b8..273d5f6 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/loki.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/loki.md @@ -8,116 +8,168 @@ grafonnet.query.loki * [`fn withDatasource(value)`](#fn-withdatasource) * [`fn withEditorMode(value)`](#fn-witheditormode) * [`fn withExpr(value)`](#fn-withexpr) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withInstant(value)`](#fn-withinstant) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withInstant(value=true)`](#fn-withinstant) * [`fn withLegendFormat(value)`](#fn-withlegendformat) * [`fn withMaxLines(value)`](#fn-withmaxlines) * [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRange(value)`](#fn-withrange) +* [`fn withRange(value=true)`](#fn-withrange) * [`fn withRefId(value)`](#fn-withrefid) * [`fn withResolution(value)`](#fn-withresolution) +* [`fn withStep(value)`](#fn-withstep) ## Fields ### fn new -```ts +```jsonnet new(datasource, expr) ``` -Creates a new loki query target for panels. +PARAMETERS: + +* **datasource** (`string`) +* **expr** (`string`) +Creates a new loki query target for panels. ### fn withDatasource -```ts +```jsonnet withDatasource(value) ``` -Set the datasource for this query. +PARAMETERS: + +* **value** (`string`) +Set the datasource for this query. ### fn withEditorMode -```ts +```jsonnet withEditorMode(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"code"`, `"builder"` -Accepted values for `value` are "code", "builder" ### fn withExpr -```ts +```jsonnet withExpr(value) ``` -The LogQL query. +PARAMETERS: + +* **value** (`string`) +The LogQL query. ### fn withHide -```ts -withHide(value) +```jsonnet +withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - ### fn withInstant -```ts -withInstant(value) +```jsonnet +withInstant(value=true) ``` -@deprecated, now use queryType. +PARAMETERS: +* **value** (`boolean`) + - default value: `true` + +@deprecated, now use queryType. ### fn withLegendFormat -```ts +```jsonnet withLegendFormat(value) ``` -Used to override the name of the series. +PARAMETERS: + +* **value** (`string`) +Used to override the name of the series. ### fn withMaxLines -```ts +```jsonnet withMaxLines(value) ``` -Used to limit the number of log rows returned. +PARAMETERS: +* **value** (`integer`) + +Used to limit the number of log rows returned. ### fn withQueryType -```ts +```jsonnet withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - ### fn withRange -```ts -withRange(value) +```jsonnet +withRange(value=true) ``` -@deprecated, now use queryType. +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +@deprecated, now use queryType. ### fn withRefId -```ts +```jsonnet withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful. - ### fn withResolution -```ts +```jsonnet withResolution(value) ``` -Used to scale the interval value. +PARAMETERS: + +* **value** (`integer`) + +@deprecated, now use step. +### fn withStep + +```jsonnet +withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used to set step value for range queries. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/parca.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/parca.md similarity index 77% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/parca.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/parca.md index 1d52589..6edbee5 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/parca.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/parca.md @@ -5,7 +5,7 @@ grafonnet.query.parca ## Index * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withHide(value)`](#fn-withhide) +* [`fn withHide(value=true)`](#fn-withhide) * [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) * [`fn withQueryType(value)`](#fn-withquerytype) @@ -15,56 +15,77 @@ grafonnet.query.parca ### fn withDatasource -```ts +```jsonnet withDatasource(value) ``` +PARAMETERS: + +* **value** (`string`) + For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null - ### fn withHide -```ts -withHide(value) +```jsonnet +withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - ### fn withLabelSelector -```ts +```jsonnet withLabelSelector(value="{}") ``` -Specifies the query label selectors. +PARAMETERS: +* **value** (`string`) + - default value: `"{}"` + +Specifies the query label selectors. ### fn withProfileTypeId -```ts +```jsonnet withProfileTypeId(value) ``` -Specifies the type of profile to query. +PARAMETERS: + +* **value** (`string`) +Specifies the type of profile to query. ### fn withQueryType -```ts +```jsonnet withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - ### fn withRefId -```ts +```jsonnet withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/prometheus.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/prometheus.md similarity index 64% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/prometheus.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/prometheus.md index a8d5275..d211529 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/prometheus.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/prometheus.md @@ -7,128 +7,171 @@ grafonnet.query.prometheus * [`fn new(datasource, expr)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) * [`fn withEditorMode(value)`](#fn-witheditormode) -* [`fn withExemplar(value)`](#fn-withexemplar) +* [`fn withExemplar(value=true)`](#fn-withexemplar) * [`fn withExpr(value)`](#fn-withexpr) * [`fn withFormat(value)`](#fn-withformat) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withInstant(value)`](#fn-withinstant) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withInstant(value=true)`](#fn-withinstant) * [`fn withIntervalFactor(value)`](#fn-withintervalfactor) * [`fn withLegendFormat(value)`](#fn-withlegendformat) * [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRange(value)`](#fn-withrange) +* [`fn withRange(value=true)`](#fn-withrange) * [`fn withRefId(value)`](#fn-withrefid) ## Fields ### fn new -```ts +```jsonnet new(datasource, expr) ``` -Creates a new prometheus query target for panels. +PARAMETERS: + +* **datasource** (`string`) +* **expr** (`string`) +Creates a new prometheus query target for panels. ### fn withDatasource -```ts +```jsonnet withDatasource(value) ``` -Set the datasource for this query. +PARAMETERS: +* **value** (`string`) + +Set the datasource for this query. ### fn withEditorMode -```ts +```jsonnet withEditorMode(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"code"`, `"builder"` -Accepted values for `value` are "code", "builder" ### fn withExemplar -```ts -withExemplar(value) +```jsonnet +withExemplar(value=true) ``` -Execute an additional query to identify interesting raw samples relevant for the given expr +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` +Execute an additional query to identify interesting raw samples relevant for the given expr ### fn withExpr -```ts +```jsonnet withExpr(value) ``` -The actual expression/query that will be evaluated by Prometheus +PARAMETERS: +* **value** (`string`) + +The actual expression/query that will be evaluated by Prometheus ### fn withFormat -```ts +```jsonnet withFormat(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"time_series"`, `"table"`, `"heatmap"` -Accepted values for `value` are "time_series", "table", "heatmap" ### fn withHide -```ts -withHide(value) +```jsonnet +withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - ### fn withInstant -```ts -withInstant(value) +```jsonnet +withInstant(value=true) ``` -Returns only the latest value that Prometheus has scraped for the requested time series +PARAMETERS: +* **value** (`boolean`) + - default value: `true` + +Returns only the latest value that Prometheus has scraped for the requested time series ### fn withIntervalFactor -```ts +```jsonnet withIntervalFactor(value) ``` -Set the interval factor for this query. +PARAMETERS: + +* **value** (`string`) +Set the interval factor for this query. ### fn withLegendFormat -```ts +```jsonnet withLegendFormat(value) ``` -Set the legend format for this query. +PARAMETERS: +* **value** (`string`) + +Set the legend format for this query. ### fn withQueryType -```ts +```jsonnet withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - ### fn withRange -```ts -withRange(value) +```jsonnet +withRange(value=true) ``` -Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series +PARAMETERS: +* **value** (`boolean`) + - default value: `true` + +Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series ### fn withRefId -```ts +```jsonnet withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/filters.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/filters.md new file mode 100644 index 0000000..4482fd2 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/filters.md @@ -0,0 +1,94 @@ +# filters + + + +## Index + +* [`fn withId(value)`](#fn-withid) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withTag(value)`](#fn-withtag) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) +* [`fn withValueType(value)`](#fn-withvaluetype) + +## Fields + +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Uniquely identify the filter, will not be used in the query generation +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The operator that connects the tag to the value, for example: =, >, !=, =~ +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` + +static fields are pre-set in the UI, dynamic fields are added by the user +### fn withTag + +```jsonnet +withTag(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The tag for the search filter, for example: .http.status_code, .service.name, status +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueType + +```jsonnet +withValueType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/groupBy.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/groupBy.md new file mode 100644 index 0000000..795b78e --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/groupBy.md @@ -0,0 +1,94 @@ +# groupBy + + + +## Index + +* [`fn withId(value)`](#fn-withid) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withTag(value)`](#fn-withtag) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) +* [`fn withValueType(value)`](#fn-withvaluetype) + +## Fields + +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Uniquely identify the filter, will not be used in the query generation +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The operator that connects the tag to the value, for example: =, >, !=, =~ +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` + +static fields are pre-set in the UI, dynamic fields are added by the user +### fn withTag + +```jsonnet +withTag(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The tag for the search filter, for example: .http.status_code, .service.name, status +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueType + +```jsonnet +withValueType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/index.md new file mode 100644 index 0000000..2e247c6 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/tempo/index.md @@ -0,0 +1,264 @@ +# tempo + +grafonnet.query.tempo + +## Subpackages + +* [filters](filters.md) +* [groupBy](groupBy.md) + +## Index + +* [`fn new(datasource, query, filters)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLimit(value)`](#fn-withlimit) +* [`fn withMaxDuration(value)`](#fn-withmaxduration) +* [`fn withMinDuration(value)`](#fn-withminduration) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSearch(value)`](#fn-withsearch) +* [`fn withServiceMapIncludeNamespace(value=true)`](#fn-withservicemapincludenamespace) +* [`fn withServiceMapQuery(value)`](#fn-withservicemapquery) +* [`fn withServiceName(value)`](#fn-withservicename) +* [`fn withSpanName(value)`](#fn-withspanname) +* [`fn withSpss(value)`](#fn-withspss) +* [`fn withTableType(value)`](#fn-withtabletype) + +## Fields + +### fn new + +```jsonnet +new(datasource, query, filters) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **query** (`string`) +* **filters** (`array`) + +Creates a new tempo query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters that are used to query the metrics summary +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters that are used to query the metrics summary +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +Note this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withLimit + +```jsonnet +withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Defines the maximum number of traces that are returned from Tempo +### fn withMaxDuration + +```jsonnet +withMaxDuration(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms +### fn withMinDuration + +```jsonnet +withMinDuration(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +TraceQL query or trace ID +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSearch + +```jsonnet +withSearch(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true +### fn withServiceMapIncludeNamespace + +```jsonnet +withServiceMapIncludeNamespace(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Use service.namespace in addition to service.name to uniquely identify a service. +### fn withServiceMapQuery + +```jsonnet +withServiceMapQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"} +### fn withServiceName + +```jsonnet +withServiceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Query traces by service name +### fn withSpanName + +```jsonnet +withSpanName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Query traces by span name +### fn withSpss + +```jsonnet +withSpss(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Defines the maximum number of spans per spanset that are returned from Tempo +### fn withTableType + +```jsonnet +withTableType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"traces"`, `"spans"` + +The type of the table that is used to display the search results \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/testData/csvWave.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/testData/csvWave.md new file mode 100644 index 0000000..8927e1c --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/testData/csvWave.md @@ -0,0 +1,56 @@ +# csvWave + + + +## Index + +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeStep(value)`](#fn-withtimestep) +* [`fn withValuesCSV(value)`](#fn-withvaluescsv) + +## Fields + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeStep + +```jsonnet +withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withValuesCSV + +```jsonnet +withValuesCSV(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/testData.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/testData/index.md similarity index 55% rename from vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/testData.md rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/testData/index.md index 2915428..a3cb948 100644 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/testData.md +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/query/testData/index.md @@ -2,6 +2,10 @@ grafonnet.query.testData +## Subpackages + +* [csvWave](csvWave.md) + ## Index * [`fn withAlias(value)`](#fn-withalias) @@ -11,10 +15,12 @@ grafonnet.query.testData * [`fn withCsvWave(value)`](#fn-withcsvwave) * [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDropPercent(value)`](#fn-withdroppercent) * [`fn withErrorType(value)`](#fn-witherrortype) -* [`fn withHide(value)`](#fn-withhide) +* [`fn withFlamegraphDiff(value=true)`](#fn-withflamegraphdiff) +* [`fn withHide(value=true)`](#fn-withhide) * [`fn withLabels(value)`](#fn-withlabels) -* [`fn withLevelColumn(value)`](#fn-withlevelcolumn) +* [`fn withLevelColumn(value=true)`](#fn-withlevelcolumn) * [`fn withLines(value)`](#fn-withlines) * [`fn withNodes(value)`](#fn-withnodes) * [`fn withNodesMixin(value)`](#fn-withnodesmixin) @@ -35,11 +41,6 @@ grafonnet.query.testData * [`fn withStringInput(value)`](#fn-withstringinput) * [`fn withUsa(value)`](#fn-withusa) * [`fn withUsaMixin(value)`](#fn-withusamixin) -* [`obj csvWave`](#obj-csvwave) - * [`fn withLabels(value)`](#fn-csvwavewithlabels) - * [`fn withName(value)`](#fn-csvwavewithname) - * [`fn withTimeStep(value)`](#fn-csvwavewithtimestep) - * [`fn withValuesCSV(value)`](#fn-csvwavewithvaluescsv) * [`obj nodes`](#obj-nodes) * [`fn withCount(value)`](#fn-nodeswithcount) * [`fn withType(value)`](#fn-nodeswithtype) @@ -54,8 +55,8 @@ grafonnet.query.testData * [`fn withConfigMixin(value)`](#fn-simwithconfigmixin) * [`fn withKey(value)`](#fn-simwithkey) * [`fn withKeyMixin(value)`](#fn-simwithkeymixin) - * [`fn withLast(value)`](#fn-simwithlast) - * [`fn withStream(value)`](#fn-simwithstream) + * [`fn withLast(value=true)`](#fn-simwithlast) + * [`fn withStream(value=true)`](#fn-simwithstream) * [`obj key`](#obj-simkey) * [`fn withTick(value)`](#fn-simkeywithtick) * [`fn withType(value)`](#fn-simkeywithtype) @@ -79,297 +80,378 @@ grafonnet.query.testData ### fn withAlias -```ts +```jsonnet withAlias(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withChannel -```ts +```jsonnet withChannel(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withCsvContent -```ts +```jsonnet withCsvContent(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withCsvFileName -```ts +```jsonnet withCsvFileName(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withCsvWave -```ts +```jsonnet withCsvWave(value) ``` +PARAMETERS: + +* **value** (`array`) ### fn withCsvWaveMixin -```ts +```jsonnet withCsvWaveMixin(value) ``` +PARAMETERS: + +* **value** (`array`) ### fn withDatasource -```ts +```jsonnet withDatasource(value) ``` +PARAMETERS: + +* **value** (`string`) + For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null +### fn withDropPercent + +```jsonnet +withDropPercent(value) +``` +PARAMETERS: + +* **value** (`number`) + +Drop percentage (the chance we will lose a point 0-100) ### fn withErrorType -```ts +```jsonnet withErrorType(value) ``` +PARAMETERS: + +* **value** (`string`) + - valid values: `"server_panic"`, `"frontend_exception"`, `"frontend_observable"` + + +### fn withFlamegraphDiff + +```jsonnet +withFlamegraphDiff(value=true) +``` + +PARAMETERS: +* **value** (`boolean`) + - default value: `true` -Accepted values for `value` are "server_panic", "frontend_exception", "frontend_observable" ### fn withHide -```ts -withHide(value) +```jsonnet +withHide(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + true if query is disabled (ie should not be returned to the dashboard) Note this does not always imply that the query should not be executed since the results from a hidden query may be used as the input to other queries (SSE etc) - ### fn withLabels -```ts +```jsonnet withLabels(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withLevelColumn -```ts -withLevelColumn(value) +```jsonnet +withLevelColumn(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` ### fn withLines -```ts +```jsonnet withLines(value) ``` +PARAMETERS: + +* **value** (`integer`) ### fn withNodes -```ts +```jsonnet withNodes(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withNodesMixin -```ts +```jsonnet withNodesMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withPoints -```ts +```jsonnet withPoints(value) ``` +PARAMETERS: + +* **value** (`array`) ### fn withPointsMixin -```ts +```jsonnet withPointsMixin(value) ``` +PARAMETERS: + +* **value** (`array`) ### fn withPulseWave -```ts +```jsonnet withPulseWave(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withPulseWaveMixin -```ts +```jsonnet withPulseWaveMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withQueryType -```ts +```jsonnet withQueryType(value) ``` +PARAMETERS: + +* **value** (`string`) + Specify the query flavor TODO make this required and give it a default - ### fn withRawFrameContent -```ts +```jsonnet withRawFrameContent(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withRefId -```ts +```jsonnet withRefId(value) ``` +PARAMETERS: + +* **value** (`string`) + A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful. - ### fn withScenarioId -```ts +```jsonnet withScenarioId(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"random_walk"`, `"slow_query"`, `"random_walk_with_error"`, `"random_walk_table"`, `"exponential_heatmap_bucket_data"`, `"linear_heatmap_bucket_data"`, `"no_data_points"`, `"datapoints_outside_range"`, `"csv_metric_values"`, `"predictable_pulse"`, `"predictable_csv_wave"`, `"streaming_client"`, `"simulation"`, `"usa"`, `"live"`, `"grafana_api"`, `"arrow"`, `"annotations"`, `"table_static"`, `"server_error_500"`, `"logs"`, `"node_graph"`, `"flame_graph"`, `"raw_frame"`, `"csv_file"`, `"csv_content"`, `"trace"`, `"manual_entry"`, `"variables-query"` -Accepted values for `value` are "random_walk", "slow_query", "random_walk_with_error", "random_walk_table", "exponential_heatmap_bucket_data", "linear_heatmap_bucket_data", "no_data_points", "datapoints_outside_range", "csv_metric_values", "predictable_pulse", "predictable_csv_wave", "streaming_client", "simulation", "usa", "live", "grafana_api", "arrow", "annotations", "table_static", "server_error_500", "logs", "node_graph", "flame_graph", "raw_frame", "csv_file", "csv_content", "trace", "manual_entry", "variables-query" ### fn withSeriesCount -```ts +```jsonnet withSeriesCount(value) ``` +PARAMETERS: + +* **value** (`integer`) ### fn withSim -```ts +```jsonnet withSim(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withSimMixin -```ts +```jsonnet withSimMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withSpanCount -```ts +```jsonnet withSpanCount(value) ``` +PARAMETERS: + +* **value** (`integer`) ### fn withStream -```ts +```jsonnet withStream(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withStreamMixin -```ts +```jsonnet withStreamMixin(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withStringInput -```ts +```jsonnet withStringInput(value) ``` +PARAMETERS: + +* **value** (`string`) ### fn withUsa -```ts +```jsonnet withUsa(value) ``` +PARAMETERS: + +* **value** (`object`) ### fn withUsaMixin -```ts +```jsonnet withUsaMixin(value) ``` +PARAMETERS: - -### obj csvWave - - -#### fn csvWave.withLabels - -```ts -withLabels(value) -``` - - - -#### fn csvWave.withName - -```ts -withName(value) -``` - - - -#### fn csvWave.withTimeStep - -```ts -withTimeStep(value) -``` - - - -#### fn csvWave.withValuesCSV - -```ts -withValuesCSV(value) -``` - +* **value** (`object`) ### obj nodes @@ -377,63 +459,83 @@ withValuesCSV(value) #### fn nodes.withCount -```ts -withCount(value) +```jsonnet +nodes.withCount(value) ``` +PARAMETERS: + +* **value** (`integer`) #### fn nodes.withType -```ts -withType(value) +```jsonnet +nodes.withType(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"random"`, `"response"`, `"random edges"` -Accepted values for `value` are "random", "response", "random edges" ### obj pulseWave #### fn pulseWave.withOffCount -```ts -withOffCount(value) +```jsonnet +pulseWave.withOffCount(value) ``` +PARAMETERS: + +* **value** (`integer`) #### fn pulseWave.withOffValue -```ts -withOffValue(value) +```jsonnet +pulseWave.withOffValue(value) ``` +PARAMETERS: + +* **value** (`number`) #### fn pulseWave.withOnCount -```ts -withOnCount(value) +```jsonnet +pulseWave.withOnCount(value) ``` +PARAMETERS: + +* **value** (`integer`) #### fn pulseWave.withOnValue -```ts -withOnValue(value) +```jsonnet +pulseWave.withOnValue(value) ``` +PARAMETERS: + +* **value** (`number`) #### fn pulseWave.withTimeStep -```ts -withTimeStep(value) +```jsonnet +pulseWave.withTimeStep(value) ``` +PARAMETERS: + +* **value** (`integer`) ### obj sim @@ -441,50 +543,70 @@ withTimeStep(value) #### fn sim.withConfig -```ts -withConfig(value) +```jsonnet +sim.withConfig(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn sim.withConfigMixin -```ts -withConfigMixin(value) +```jsonnet +sim.withConfigMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn sim.withKey -```ts -withKey(value) +```jsonnet +sim.withKey(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn sim.withKeyMixin -```ts -withKeyMixin(value) +```jsonnet +sim.withKeyMixin(value) ``` +PARAMETERS: + +* **value** (`object`) #### fn sim.withLast -```ts -withLast(value) +```jsonnet +sim.withLast(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` #### fn sim.withStream -```ts -withStream(value) +```jsonnet +sim.withStream(value=true) ``` +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` #### obj sim.key @@ -492,26 +614,35 @@ withStream(value) ##### fn sim.key.withTick -```ts -withTick(value) +```jsonnet +sim.key.withTick(value) ``` +PARAMETERS: + +* **value** (`number`) ##### fn sim.key.withType -```ts -withType(value) +```jsonnet +sim.key.withType(value) ``` +PARAMETERS: + +* **value** (`string`) ##### fn sim.key.withUid -```ts -withUid(value) +```jsonnet +sim.key.withUid(value) ``` +PARAMETERS: + +* **value** (`string`) ### obj stream @@ -519,52 +650,69 @@ withUid(value) #### fn stream.withBands -```ts -withBands(value) +```jsonnet +stream.withBands(value) ``` +PARAMETERS: + +* **value** (`integer`) #### fn stream.withNoise -```ts -withNoise(value) +```jsonnet +stream.withNoise(value) ``` +PARAMETERS: + +* **value** (`integer`) #### fn stream.withSpeed -```ts -withSpeed(value) +```jsonnet +stream.withSpeed(value) ``` +PARAMETERS: + +* **value** (`integer`) #### fn stream.withSpread -```ts -withSpread(value) +```jsonnet +stream.withSpread(value) ``` +PARAMETERS: + +* **value** (`integer`) #### fn stream.withType -```ts -withType(value) +```jsonnet +stream.withType(value) ``` +PARAMETERS: +* **value** (`string`) + - valid values: `"signal"`, `"logs"`, `"fetch"` -Accepted values for `value` are "signal", "logs", "fetch" #### fn stream.withUrl -```ts -withUrl(value) +```jsonnet +stream.withUrl(value) ``` +PARAMETERS: + +* **value** (`string`) ### obj usa @@ -572,48 +720,66 @@ withUrl(value) #### fn usa.withFields -```ts -withFields(value) +```jsonnet +usa.withFields(value) ``` +PARAMETERS: + +* **value** (`array`) #### fn usa.withFieldsMixin -```ts -withFieldsMixin(value) +```jsonnet +usa.withFieldsMixin(value) ``` +PARAMETERS: + +* **value** (`array`) #### fn usa.withMode -```ts -withMode(value) +```jsonnet +usa.withMode(value) ``` +PARAMETERS: + +* **value** (`string`) #### fn usa.withPeriod -```ts -withPeriod(value) +```jsonnet +usa.withPeriod(value) ``` +PARAMETERS: + +* **value** (`string`) #### fn usa.withStates -```ts -withStates(value) +```jsonnet +usa.withStates(value) ``` +PARAMETERS: + +* **value** (`array`) #### fn usa.withStatesMixin -```ts -withStatesMixin(value) +```jsonnet +usa.withStatesMixin(value) ``` +PARAMETERS: + +* **value** (`array`) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/role.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/role.md new file mode 100644 index 0000000..b5b551c --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/role.md @@ -0,0 +1,70 @@ +# role + +grafonnet.role + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withDisplayName(value)`](#fn-withdisplayname) +* [`fn withGroupName(value)`](#fn-withgroupname) +* [`fn withHidden(value=true)`](#fn-withhidden) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Role description +### fn withDisplayName + +```jsonnet +withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display +### fn withGroupName + +```jsonnet +withGroupName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the team. +### fn withHidden + +```jsonnet +withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Do not show this role +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The role identifier `managed:builtins:editor:permissions` \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/rolebinding.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/rolebinding.md new file mode 100644 index 0000000..62357f5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/rolebinding.md @@ -0,0 +1,197 @@ +# rolebinding + +grafonnet.rolebinding + +## Index + +* [`fn withRole(value)`](#fn-withrole) +* [`fn withRoleMixin(value)`](#fn-withrolemixin) +* [`fn withSubject(value)`](#fn-withsubject) +* [`fn withSubjectMixin(value)`](#fn-withsubjectmixin) +* [`obj role`](#obj-role) + * [`fn withBuiltinRoleRef(value)`](#fn-rolewithbuiltinroleref) + * [`fn withBuiltinRoleRefMixin(value)`](#fn-rolewithbuiltinrolerefmixin) + * [`fn withCustomRoleRef(value)`](#fn-rolewithcustomroleref) + * [`fn withCustomRoleRefMixin(value)`](#fn-rolewithcustomrolerefmixin) + * [`obj BuiltinRoleRef`](#obj-rolebuiltinroleref) + * [`fn withKind(value)`](#fn-rolebuiltinrolerefwithkind) + * [`fn withName(value)`](#fn-rolebuiltinrolerefwithname) + * [`obj CustomRoleRef`](#obj-rolecustomroleref) + * [`fn withKind(value)`](#fn-rolecustomrolerefwithkind) + * [`fn withName(value)`](#fn-rolecustomrolerefwithname) +* [`obj subject`](#obj-subject) + * [`fn withKind(value)`](#fn-subjectwithkind) + * [`fn withName(value)`](#fn-subjectwithname) + +## Fields + +### fn withRole + +```jsonnet +withRole(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role we are discussing +### fn withRoleMixin + +```jsonnet +withRoleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role we are discussing +### fn withSubject + +```jsonnet +withSubject(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSubjectMixin + +```jsonnet +withSubjectMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj role + + +#### fn role.withBuiltinRoleRef + +```jsonnet +role.withBuiltinRoleRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withBuiltinRoleRefMixin + +```jsonnet +role.withBuiltinRoleRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withCustomRoleRef + +```jsonnet +role.withCustomRoleRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withCustomRoleRefMixin + +```jsonnet +role.withCustomRoleRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj role.BuiltinRoleRef + + +##### fn role.BuiltinRoleRef.withKind + +```jsonnet +role.BuiltinRoleRef.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"BuiltinRole"` + + +##### fn role.BuiltinRoleRef.withName + +```jsonnet +role.BuiltinRoleRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"viewer"`, `"editor"`, `"admin"` + + +#### obj role.CustomRoleRef + + +##### fn role.CustomRoleRef.withKind + +```jsonnet +role.CustomRoleRef.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Role"` + + +##### fn role.CustomRoleRef.withName + +```jsonnet +role.CustomRoleRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj subject + + +#### fn subject.withKind + +```jsonnet +subject.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Team"`, `"User"` + + +#### fn subject.withName + +```jsonnet +subject.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The team/user identifier name \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/team.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/team.md new file mode 100644 index 0000000..cce602b --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/team.md @@ -0,0 +1,33 @@ +# team + +grafonnet.team + +## Index + +* [`fn withEmail(value)`](#fn-withemail) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withEmail + +```jsonnet +withEmail(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Email of the team. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the team. \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/util.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/util.md new file mode 100644 index 0000000..23c11d5 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/docs/util.md @@ -0,0 +1,259 @@ +# util + +Helper functions that work well with Grafonnet. + +## Index + +* [`obj dashboard`](#obj-dashboard) + * [`fn getOptionsForCustomQuery(query)`](#fn-dashboardgetoptionsforcustomquery) +* [`obj grid`](#obj-grid) + * [`fn makeGrid(panels, panelWidth, panelHeight, startY)`](#fn-gridmakegrid) + * [`fn wrapPanels(panels, panelWidth, panelHeight, startY)`](#fn-gridwrappanels) +* [`obj panel`](#obj-panel) + * [`fn calculateLowestYforPanel(panel, panels)`](#fn-panelcalculatelowestyforpanel) + * [`fn getPanelsBeforeNextRow(panels)`](#fn-panelgetpanelsbeforenextrow) + * [`fn groupPanelsInRows(panels)`](#fn-panelgrouppanelsinrows) + * [`fn mapToRows(func, panels)`](#fn-panelmaptorows) + * [`fn normalizeY(panels)`](#fn-panelnormalizey) + * [`fn normalizeYInRow(rowPanel)`](#fn-panelnormalizeyinrow) + * [`fn resolveCollapsedFlagOnRows(panels)`](#fn-panelresolvecollapsedflagonrows) + * [`fn sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8)`](#fn-panelsanitizepanel) + * [`fn setPanelIDs(panels)`](#fn-panelsetpanelids) + * [`fn sortPanelsByXY(panels)`](#fn-panelsortpanelsbyxy) + * [`fn sortPanelsInRow(rowPanel)`](#fn-panelsortpanelsinrow) +* [`obj string`](#obj-string) + * [`fn slugify(string)`](#fn-stringslugify) + +## Fields + +### obj dashboard + + +#### fn dashboard.getOptionsForCustomQuery + +```jsonnet +dashboard.getOptionsForCustomQuery(query) +``` + +PARAMETERS: + +* **query** (`string`) + +`getOptionsForCustomQuery` provides values for the `options` and `current` fields. +These are required for template variables of type 'custom'but do not automatically +get populated by Grafana when importing a dashboard from JSON. + +This is a bit of a hack and should always be called on functions that set `type` on +a template variable. Ideally Grafana populates these fields from the `query` value +but this provides a backwards compatible solution. + +### obj grid + + +#### fn grid.makeGrid + +```jsonnet +grid.makeGrid(panels, panelWidth, panelHeight, startY) +``` + +PARAMETERS: + +* **panels** (`array`) +* **panelWidth** (`number`) +* **panelHeight** (`number`) +* **startY** (`number`) + +`makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` +and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, +then all panels below it will be folded into the row. + +This function will use the full grid of 24 columns, setting `panelWidth` to a value +that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) +Other value for `panelWidth` will leave a gap on the far right. + +Optional `startY` can be provided to place generated grid above or below existing panels. + +#### fn grid.wrapPanels + +```jsonnet +grid.wrapPanels(panels, panelWidth, panelHeight, startY) +``` + +PARAMETERS: + +* **panels** (`array`) +* **panelWidth** (`number`) +* **panelHeight** (`number`) +* **startY** (`number`) + +`wrapPanels` returns an array of `panels` organized in a grid, wrapping up to next 'row' if total width exceeds full grid of 24 columns. +'panelHeight' and 'panelWidth' are used unless panels already have height and width defined. + +### obj panel + + +#### fn panel.calculateLowestYforPanel + +```jsonnet +panel.calculateLowestYforPanel(panel, panels) +``` + +PARAMETERS: + +* **panel** (`object`) +* **panels** (`array`) + +`calculateLowestYforPanel` calculates Y for a given `panel` from the `gridPos` of an array of `panels`. This function is used in `normalizeY`. + +#### fn panel.getPanelsBeforeNextRow + +```jsonnet +panel.getPanelsBeforeNextRow(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`getPanelsBeforeNextRow` returns all panels in an array up until a row has been found. Used in `groupPanelsInRows`. + +#### fn panel.groupPanelsInRows + +```jsonnet +panel.groupPanelsInRows(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`groupPanelsInRows` ensures that panels that come after a row panel in an array are added to the `row.panels` attribute. This can be useful to apply intermediate functions to only the panels that belong to a row. Finally the panel array should get processed by `resolveCollapsedFlagOnRows` to "unfold" the rows that are not collapsed into the main array. + +#### fn panel.mapToRows + +```jsonnet +panel.mapToRows(func, panels) +``` + +PARAMETERS: + +* **func** (`function`) +* **panels** (`array`) + +`mapToRows` is a little helper function that applies `func` to all row panels in an array. Other panels in that array are returned ad verbatim. + +#### fn panel.normalizeY + +```jsonnet +panel.normalizeY(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`normalizeY` applies negative gravity on the inverted Y axis. This mimics the behavior of Grafana: when a panel is created without panel above it, then it'll float upward. + +This is strictly not required as Grafana will do this on dashboard load, however it might be helpful when used when calculating the correct `gridPos`. + +#### fn panel.normalizeYInRow + +```jsonnet +panel.normalizeYInRow(rowPanel) +``` + +PARAMETERS: + +* **rowPanel** (`object`) + +`normalizeYInRow` applies `normalizeY` to the panels in a row panel. + +#### fn panel.resolveCollapsedFlagOnRows + +```jsonnet +panel.resolveCollapsedFlagOnRows(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`resolveCollapsedFlagOnRows` should be applied to the final panel array to "unfold" the rows that are not collapsed into the main array. + +#### fn panel.sanitizePanel + +```jsonnet +panel.sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8) +``` + +PARAMETERS: + +* **panel** (`object`) +* **defaultX** (`number`) + - default value: `0` +* **defaultY** (`number`) + - default value: `0` +* **defaultHeight** (`number`) + - default value: `8` +* **defaultWidth** (`number`) + - default value: `8` + +`sanitizePanel` ensures the panel has a valid `gridPos` and row panels have `collapsed` and `panels`. This function is recursively applied to panels inside row panels. + +The default values for x,y,h,w are only applied if not already set. + +#### fn panel.setPanelIDs + +```jsonnet +panel.setPanelIDs(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`setPanelIDs` ensures that all `panels` have a unique ID, this functions is used in +`dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent +experience. + +used in ../dashboard.libsonnet + +#### fn panel.sortPanelsByXY + +```jsonnet +panel.sortPanelsByXY(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`sortPanelsByXY` applies a simple sorting algorithm, first by x then again by y. This does not take width and height into account. + +#### fn panel.sortPanelsInRow + +```jsonnet +panel.sortPanelsInRow(rowPanel) +``` + +PARAMETERS: + +* **rowPanel** (`object`) + +`sortPanelsInRow` applies `sortPanelsByXY` on the panels in a rowPanel. + +### obj string + + +#### fn string.slugify + +```jsonnet +string.slugify(string) +``` + +PARAMETERS: + +* **string** (`string`) + +`slugify` will create a simple slug from `string`, keeping only alphanumeric +characters and replacing spaces with dashes. diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/jsonnetfile.json b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/jsonnetfile.json similarity index 63% rename from vendor/github.com/crdsonnet/crdsonnet/crdsonnet/jsonnetfile.json rename to vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/jsonnetfile.json index 881998e..8479d5a 100644 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/jsonnetfile.json +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/jsonnetfile.json @@ -1,15 +1,5 @@ { - "version": 1, "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/validate-libsonnet.git", - "subdir": "" - } - }, - "version": "master" - }, { "source": { "git": { @@ -29,5 +19,6 @@ "version": "master" } ], - "legacyImports": true -} + "legacyImports": true, + "version": 1 +} \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/main.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/main.libsonnet new file mode 100644 index 0000000..27bb6f2 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/main.libsonnet @@ -0,0 +1,26 @@ +// This file is generated, do not manually edit. +{ + '#': { + filename: 'main.libsonnet', + help: 'Jsonnet library for rendering Grafana resources\n## Install\n\n```\njb install github.com/grafana/grafonnet/gen/grafonnet-v10.2.0@main\n```\n\n## Usage\n\n```jsonnet\nlocal grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/main.libsonnet"\n```\n', + 'import': 'github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/main.libsonnet', + installTemplate: '\n## Install\n\n```\njb install %(url)s@%(version)s\n```\n', + name: 'grafonnet', + url: 'github.com/grafana/grafonnet/gen/grafonnet-v10.2.0', + usageTemplate: '\n## Usage\n\n```jsonnet\nlocal %(name)s = import "%(import)s"\n```\n', + version: 'main', + }, + accesspolicy: import 'raw/accesspolicy.libsonnet', + dashboard: import 'clean/dashboard.libsonnet', + folder: import 'raw/folder.libsonnet', + librarypanel: import 'raw/librarypanel.libsonnet', + preferences: import 'raw/preferences.libsonnet', + publicdashboard: import 'raw/publicdashboard.libsonnet', + role: import 'raw/role.libsonnet', + rolebinding: import 'raw/rolebinding.libsonnet', + team: import 'raw/team.libsonnet', + panel: import 'panel.libsonnet', + query: import 'query.libsonnet', + util: import 'custom/util/main.libsonnet', + alerting: import 'alerting.libsonnet', +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/panel.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/panel.libsonnet new file mode 100644 index 0000000..466d30a --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/panel.libsonnet @@ -0,0 +1,31 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + alertList: import 'clean/panel/alertList.libsonnet', + alertGroups: import 'clean/panel/alertGroups.libsonnet', + annotationsList: import 'clean/panel/annotationsList.libsonnet', + barChart: import 'clean/panel/barChart.libsonnet', + barGauge: import 'clean/panel/barGauge.libsonnet', + candlestick: import 'clean/panel/candlestick.libsonnet', + canvas: import 'clean/panel/canvas.libsonnet', + dashboardList: import 'clean/panel/dashboardList.libsonnet', + datagrid: import 'clean/panel/datagrid.libsonnet', + debug: import 'clean/panel/debug.libsonnet', + gauge: import 'clean/panel/gauge.libsonnet', + geomap: import 'clean/panel/geomap.libsonnet', + heatmap: import 'clean/panel/heatmap.libsonnet', + histogram: import 'clean/panel/histogram.libsonnet', + logs: import 'clean/panel/logs.libsonnet', + news: import 'clean/panel/news.libsonnet', + nodeGraph: import 'clean/panel/nodeGraph.libsonnet', + pieChart: import 'clean/panel/pieChart.libsonnet', + stat: import 'clean/panel/stat.libsonnet', + stateTimeline: import 'clean/panel/stateTimeline.libsonnet', + statusHistory: import 'clean/panel/statusHistory.libsonnet', + table: import 'clean/panel/table.libsonnet', + text: import 'clean/panel/text.libsonnet', + timeSeries: import 'clean/panel/timeSeries.libsonnet', + trend: import 'clean/panel/trend.libsonnet', + xyChart: import 'clean/panel/xyChart.libsonnet', + row: import 'raw/panel/row.libsonnet', +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/query.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/query.libsonnet new file mode 100644 index 0000000..116452d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/query.libsonnet @@ -0,0 +1,14 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query', name: 'query' }, + azureMonitor: import 'raw/query/azureMonitor.libsonnet', + googleCloudMonitoring: import 'raw/query/googleCloudMonitoring.libsonnet', + cloudWatch: import 'raw/query/cloudWatch.libsonnet', + elasticsearch: import 'raw/query/elasticsearch.libsonnet', + grafanaPyroscope: import 'raw/query/grafanaPyroscope.libsonnet', + testData: import 'raw/query/testData.libsonnet', + loki: import 'clean/query/loki.libsonnet', + parca: import 'raw/query/parca.libsonnet', + prometheus: import 'clean/query/prometheus.libsonnet', + tempo: import 'clean/query/tempo.libsonnet', +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/accesspolicy.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/accesspolicy.libsonnet new file mode 100644 index 0000000..1881f85 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/accesspolicy.libsonnet @@ -0,0 +1,46 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.accesspolicy', name: 'accesspolicy' }, + '#withRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRole(value): { role: value }, + '#withRoleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRoleMixin(value): { role+: value }, + role+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Role', 'BuiltinRole', 'Team', 'User'], name: 'value', type: ['string'] }], help: 'Policies can apply to roles, teams, or users\nApplying policies to individual users is supported, but discouraged' } }, + withKind(value): { role+: { kind: value } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { role+: { name: value } }, + '#withXname': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withXname(value): { role+: { xname: value } }, + }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The set of rules to apply. Note that * is required to modify\naccess policy rules, and that "none" will reject all actions' } }, + withRules(value): { rules: (if std.isArray(value) + then value + else [value]) }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The set of rules to apply. Note that * is required to modify\naccess policy rules, and that "none" will reject all actions' } }, + withRulesMixin(value): { rules+: (if std.isArray(value) + then value + else [value]) }, + rules+: + { + '#': { help: '', name: 'rules' }, + '#withKind': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The kind this rule applies to (dashboards, alert, etc)' } }, + withKind(value): { kind: value }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific sub-elements like "alert.rules" or "dashboard.permissions"????' } }, + withTarget(value): { target: value }, + '#withVerb': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'READ, WRITE, CREATE, DELETE, ...\nshould move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete"' } }, + withVerb(value): { verb: value }, + }, + '#withScope': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withScope(value): { scope: value }, + '#withScopeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withScopeMixin(value): { scope+: value }, + scope+: + { + '#withKind': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { scope+: { kind: value } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { scope+: { name: value } }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/contactPoint.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/contactPoint.libsonnet new file mode 100644 index 0000000..882405a --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/contactPoint.libsonnet @@ -0,0 +1,18 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.contactPoint', name: 'contactPoint' }, + '#withDisableResolveMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDisableResolveMessage(value=true): { disableResolveMessage: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name is used as grouping key in the UI. Contact points with the\nsame name will be grouped in the UI.' } }, + withName(value): { name: value }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { provenance: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['alertmanager', ' dingding', ' discord', ' email', ' googlechat', ' kafka', ' line', ' opsgenie', ' pagerduty', ' pushover', ' sensugo', ' slack', ' teams', ' telegram', ' threema', ' victorops', ' webhook', ' wecom'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID is the unique identifier of the contact point. The UID can be\nset by the user.' } }, + withUid(value): { uid: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/messageTemplate.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/messageTemplate.libsonnet new file mode 100644 index 0000000..098d4e1 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/messageTemplate.libsonnet @@ -0,0 +1,10 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.messageTemplate', name: 'messageTemplate' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { provenance: value }, + '#withTemplate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTemplate(value): { template: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/muteTiming.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/muteTiming.libsonnet new file mode 100644 index 0000000..658dea7 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/muteTiming.libsonnet @@ -0,0 +1,68 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.muteTiming', name: 'muteTiming' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { time_intervals: (if std.isArray(value) + then value + else [value]) }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { time_intervals+: (if std.isArray(value) + then value + else [value]) }, + time_intervals+: + { + '#': { help: '', name: 'time_intervals' }, + '#withDaysOfMonth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonth(value): { days_of_month: (if std.isArray(value) + then value + else [value]) }, + '#withDaysOfMonthMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonthMixin(value): { days_of_month+: (if std.isArray(value) + then value + else [value]) }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLocation(value): { location: value }, + '#withMonths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonths(value): { months: (if std.isArray(value) + then value + else [value]) }, + '#withMonthsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonthsMixin(value): { months+: (if std.isArray(value) + then value + else [value]) }, + '#withTimes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimes(value): { times: (if std.isArray(value) + then value + else [value]) }, + '#withTimesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimesMixin(value): { times+: (if std.isArray(value) + then value + else [value]) }, + times+: + { + '#': { help: '', name: 'times' }, + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value): { from: value }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTo(value): { to: value }, + }, + '#withWeekdays': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdays(value): { weekdays: (if std.isArray(value) + then value + else [value]) }, + '#withWeekdaysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdaysMixin(value): { weekdays+: (if std.isArray(value) + then value + else [value]) }, + '#withYears': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYears(value): { years: (if std.isArray(value) + then value + else [value]) }, + '#withYearsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYearsMixin(value): { years+: (if std.isArray(value) + then value + else [value]) }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/notificationPolicy.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/notificationPolicy.libsonnet new file mode 100644 index 0000000..8ed0273 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/notificationPolicy.libsonnet @@ -0,0 +1,84 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.notificationPolicy', name: 'notificationPolicy' }, + '#withContinue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withContinue(value=true): { continue: value }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { group_by: (if std.isArray(value) + then value + else [value]) }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { group_by+: (if std.isArray(value) + then value + else [value]) }, + '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupInterval(value): { group_interval: value }, + '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupWait(value): { group_wait: value }, + '#withMatch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Deprecated. Remove before v1.0 release.' } }, + withMatch(value): { match: value }, + '#withMatchMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Deprecated. Remove before v1.0 release.' } }, + withMatchMixin(value): { match+: value }, + '#withMatchRe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'MatchRegexps represents a map of Regexp.' } }, + withMatchRe(value): { match_re: value }, + '#withMatchReMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'MatchRegexps represents a map of Regexp.' } }, + withMatchReMixin(value): { match_re+: value }, + '#withMatchers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchers(value): { matchers: (if std.isArray(value) + then value + else [value]) }, + '#withMatchersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchersMixin(value): { matchers+: (if std.isArray(value) + then value + else [value]) }, + matchers+: + { + '#': { help: '', name: 'matchers' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { Name: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['=', '!=', '=~', '!~'], name: 'value', type: ['string'] }], help: 'MatchType is an enum for label matching types.' } }, + withType(value): { Type: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { Value: value }, + }, + '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervals(value): { mute_time_intervals: (if std.isArray(value) + then value + else [value]) }, + '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervalsMixin(value): { mute_time_intervals+: (if std.isArray(value) + then value + else [value]) }, + '#withObjectMatchers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withObjectMatchers(value): { object_matchers: (if std.isArray(value) + then value + else [value]) }, + '#withObjectMatchersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withObjectMatchersMixin(value): { object_matchers+: (if std.isArray(value) + then value + else [value]) }, + object_matchers+: + { + '#': { help: '', name: 'object_matchers' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { Name: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['=', '!=', '=~', '!~'], name: 'value', type: ['string'] }], help: 'MatchType is an enum for label matching types.' } }, + withType(value): { Type: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { Value: value }, + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { provenance: value }, + '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withReceiver(value): { receiver: value }, + '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRepeatInterval(value): { repeat_interval: value }, + '#withRoutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutes(value): { routes: (if std.isArray(value) + then value + else [value]) }, + '#withRoutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutesMixin(value): { routes+: (if std.isArray(value) + then value + else [value]) }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/ruleGroup.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/ruleGroup.libsonnet new file mode 100644 index 0000000..b515d28 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/alerting/ruleGroup.libsonnet @@ -0,0 +1,89 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.ruleGroup', name: 'ruleGroup' }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { folderUid: value }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withInterval(value): { interval: value }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRules(value): { rules: (if std.isArray(value) + then value + else [value]) }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRulesMixin(value): { rules+: (if std.isArray(value) + then value + else [value]) }, + rules+: + { + '#': { help: '', name: 'rules' }, + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotations(value): { annotations: value }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotationsMixin(value): { annotations+: value }, + '#withCondition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCondition(value): { condition: value }, + '#withData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withData(value): { data: (if std.isArray(value) + then value + else [value]) }, + '#withDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDataMixin(value): { data+: (if std.isArray(value) + then value + else [value]) }, + data+: + { + '#': { help: '', name: 'data' }, + '#withDatasourceUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation." } }, + withDatasourceUid(value): { datasourceUid: value }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModel(value): { model: value }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModelMixin(value): { model+: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { refId: value }, + '#withRelativeTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRange(value): { relativeTimeRange: value }, + '#withRelativeTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRangeMixin(value): { relativeTimeRange+: value }, + relativeTimeRange+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withFrom(value): { relativeTimeRange+: { from: value } }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withTo(value): { relativeTimeRange+: { to: value } }, + }, + }, + '#withExecErrState': { 'function': { args: [{ default: null, enums: ['OK', 'Alerting', 'Error'], name: 'value', type: ['string'] }], help: '' } }, + withExecErrState(value): { execErrState: value }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { folderUID: value }, + '#withFor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withFor(value): { 'for': value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { id: value }, + '#withIsPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsPaused(value=true): { isPaused: value }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabels(value): { labels: value }, + '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelsMixin(value): { labels+: value }, + '#withNoDataState': { 'function': { args: [{ default: null, enums: ['Alerting', 'NoData', 'OK'], name: 'value', type: ['string'] }], help: '' } }, + withNoDataState(value): { noDataState: value }, + '#withOrgID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOrgID(value): { orgID: value }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { provenance: value }, + '#withRuleGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRuleGroup(value): { ruleGroup: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { title: value }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUid(value): { uid: value }, + '#withUpdated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUpdated(value): { updated: value }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { title: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/dashboard.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/dashboard.libsonnet new file mode 100644 index 0000000..038b035 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/dashboard.libsonnet @@ -0,0 +1,328 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.dashboard', name: 'dashboard' }, + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Contains the list of annotations that are associated with the dashboard.\nAnnotations are used to overlay event markers and overlay event tags on graphs.\nGrafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the HTTP API.\nSee https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/' } }, + withAnnotations(value): { annotations: value }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Contains the list of annotations that are associated with the dashboard.\nAnnotations are used to overlay event markers and overlay event tags on graphs.\nGrafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the HTTP API.\nSee https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/' } }, + withAnnotationsMixin(value): { annotations+: value }, + annotations+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withList(value): { annotations+: { list: (if std.isArray(value) + then value + else [value]) } }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withListMixin(value): { annotations+: { list+: (if std.isArray(value) + then value + else [value]) } }, + list+: + { + '#': { help: '', name: 'list' }, + '#withBuiltIn': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Set to 1 for the standard annotation query all dashboards have by default.' } }, + withBuiltIn(value=0): { builtIn: value }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { datasource: value }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { datasource+: value }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { type: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { datasource+: { uid: value } }, + }, + '#withEnable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled the annotation query is issued with every dashboard refresh' } }, + withEnable(value=true): { enable: value }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFilter(value): { filter: value }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFilterMixin(value): { filter+: value }, + filter+: + { + '#withExclude': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Should the specified panels be included or excluded' } }, + withExclude(value=true): { filter+: { exclude: value } }, + '#withIds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIds(value): { filter+: { ids: (if std.isArray(value) + then value + else [value]) } }, + '#withIdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIdsMixin(value): { filter+: { ids+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Annotation queries can be toggled on or off at the top of the dashboard.\nWhen hide is true, the toggle is not shown in the dashboard.' } }, + withHide(value=true): { hide: value }, + '#withIconColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color to use for the annotation event markers' } }, + withIconColor(value): { iconColor: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of annotation.' } }, + withName(value): { name: value }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTarget(value): { target: value }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTargetMixin(value): { target+: value }, + target+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withLimit(value): { target+: { limit: value } }, + '#withMatchAny': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withMatchAny(value=true): { target+: { matchAny: value } }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTags(value): { target+: { tags: (if std.isArray(value) + then value + else [value]) } }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTagsMixin(value): { target+: { tags+: (if std.isArray(value) + then value + else [value]) } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withType(value): { target+: { type: value } }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TODO -- this should not exist here, it is based on the --grafana-- datasource' } }, + withType(value): { type: value }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of dashboard.' } }, + withDescription(value): { description: value }, + '#withEditable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether a dashboard is editable or not.' } }, + withEditable(value=true): { editable: value }, + '#withFiscalYearStartMonth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'The month that the fiscal year starts on. 0 = January, 11 = December' } }, + withFiscalYearStartMonth(value=0): { fiscalYearStartMonth: value }, + '#withGnetId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID of a dashboard imported from the https://grafana.com/grafana/dashboards/ portal' } }, + withGnetId(value): { gnetId: value }, + '#withGraphTooltip': { 'function': { args: [{ default: 0, enums: [0, 1, 2], name: 'value', type: ['integer'] }], help: '0 for no shared crosshair or tooltip (default).\n1 for shared crosshair.\n2 for shared crosshair AND shared tooltip.' } }, + withGraphTooltip(value=0): { graphTooltip: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer', 'null'] }], help: 'Unique numeric identifier for the dashboard.\n`id` is internal to a specific Grafana instance. `uid` should be used to identify a dashboard across Grafana instances.' } }, + withId(value): { id: value }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinks(value): { links: (if std.isArray(value) + then value + else [value]) }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinksMixin(value): { links+: (if std.isArray(value) + then value + else [value]) }, + links+: + { + '#': { help: '', name: 'links' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { asDropdown: value }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { icon: value }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { includeVars: value }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { keepTime: value }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { tags: (if std.isArray(value) + then value + else [value]) }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { tags+: (if std.isArray(value) + then value + else [value]) }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { targetBlank: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { title: value }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { tooltip: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { type: value }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { url: value }, + }, + '#withLiveNow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When set to true, the dashboard will redraw panels at an interval matching the pixel width.\nThis will keep data "moving left" regardless of the query refresh rate. This setting helps\navoid dashboards presenting stale live data' } }, + withLiveNow(value=true): { liveNow: value }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { panels: (if std.isArray(value) + then value + else [value]) }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { panels+: (if std.isArray(value) + then value + else [value]) }, + '#withRefresh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: 'Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d".' } }, + withRefresh(value): { refresh: value }, + '#withRefreshMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: 'Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d".' } }, + withRefreshMixin(value): { refresh+: value }, + '#withRevision': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'This property should only be used in dashboards defined by plugins. It is a quick check\nto see if the version has changed since the last time.' } }, + withRevision(value): { revision: value }, + '#withSchemaVersion': { 'function': { args: [{ default: 36, enums: null, name: 'value', type: ['integer'] }], help: 'Version of the JSON schema, incremented each time a Grafana update brings\nchanges to said schema.' } }, + withSchemaVersion(value=36): { schemaVersion: value }, + '#withSnapshot': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A dashboard snapshot shares an interactive dashboard publicly.\nIt is a read-only version of a dashboard, and is not editable.\nIt is possible to create a snapshot of a snapshot.\nGrafana strips away all sensitive information from the dashboard.\nSensitive information stripped: queries (metric, template,annotation) and panel links.' } }, + withSnapshot(value): { snapshot: value }, + '#withSnapshotMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A dashboard snapshot shares an interactive dashboard publicly.\nIt is a read-only version of a dashboard, and is not editable.\nIt is possible to create a snapshot of a snapshot.\nGrafana strips away all sensitive information from the dashboard.\nSensitive information stripped: queries (metric, template,annotation) and panel links.' } }, + withSnapshotMixin(value): { snapshot+: value }, + snapshot+: + { + '#withCreated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Time when the snapshot was created' } }, + withCreated(value): { snapshot+: { created: value } }, + '#withExpires': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Time when the snapshot expires, default is never to expire' } }, + withExpires(value): { snapshot+: { expires: value } }, + '#withExternal': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Is the snapshot saved in an external grafana instance' } }, + withExternal(value=true): { snapshot+: { external: value } }, + '#withExternalUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'external url, if snapshot was shared in external grafana instance' } }, + withExternalUrl(value): { snapshot+: { externalUrl: value } }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Unique identifier of the snapshot' } }, + withId(value): { snapshot+: { id: value } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional, defined the unique key of the snapshot, required if external is true' } }, + withKey(value): { snapshot+: { key: value } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional, name of the snapshot' } }, + withName(value): { snapshot+: { name: value } }, + '#withOrgId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'org id of the snapshot' } }, + withOrgId(value): { snapshot+: { orgId: value } }, + '#withUpdated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'last time when the snapshot was updated' } }, + withUpdated(value): { snapshot+: { updated: value } }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'url of the snapshot, if snapshot was shared internally' } }, + withUrl(value): { snapshot+: { url: value } }, + '#withUserId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'user id of the snapshot creator' } }, + withUserId(value): { snapshot+: { userId: value } }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTags(value): { tags: (if std.isArray(value) + then value + else [value]) }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTagsMixin(value): { tags+: (if std.isArray(value) + then value + else [value]) }, + '#withTemplating': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplating(value): { templating: value }, + '#withTemplatingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplatingMixin(value): { templating+: value }, + templating+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withList(value): { templating+: { list: (if std.isArray(value) + then value + else [value]) } }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withListMixin(value): { templating+: { list+: (if std.isArray(value) + then value + else [value]) } }, + list+: + { + '#': { help: '', name: 'list' }, + '#withCurrent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrent(value): { current: value }, + '#withCurrentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrentMixin(value): { current+: value }, + current+: + { + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { current+: { selected: value } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { current+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { current+: { text+: value } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { current+: { value: value } }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { current+: { value+: value } }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { datasource: value }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { datasource+: value }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { type: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { datasource+: { uid: value } }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of variable. It can be defined but `null`.' } }, + withDescription(value): { description: value }, + '#withHide': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['integer'] }], help: 'Determine if the variable shows on dashboard\nAccepted values are 0 (show label and value), 1 (show value only), 2 (show nothing).' } }, + withHide(value): { hide: value }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display name' } }, + withLabel(value): { label: value }, + '#withMulti': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether multiple values can be selected or not from variable value list' } }, + withMulti(value=true): { multi: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of variable' } }, + withName(value): { name: value }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptions(value): { options: (if std.isArray(value) + then value + else [value]) }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptionsMixin(value): { options+: (if std.isArray(value) + then value + else [value]) }, + options+: + { + '#': { help: '', name: 'options' }, + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { selected: value }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { text: value }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { text+: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { value: value }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { value+: value }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQuery(value): { query: value }, + '#withQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQueryMixin(value): { query+: value }, + '#withRefresh': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['integer'] }], help: 'Options to config when to refresh a variable\n`0`: Never refresh the variable\n`1`: Queries the data source every time the dashboard loads.\n`2`: Queries the data source when the dashboard time range changes.' } }, + withRefresh(value): { refresh: value }, + '#withSkipUrlSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the variable value should be managed by URL query params or not' } }, + withSkipUrlSync(value=true): { skipUrlSync: value }, + '#withSort': { 'function': { args: [{ default: null, enums: [0, 1, 2, 3, 4, 5, 6], name: 'value', type: ['integer'] }], help: 'Sort variable options\nAccepted values are:\n`0`: No sorting\n`1`: Alphabetical ASC\n`2`: Alphabetical DESC\n`3`: Numerical ASC\n`4`: Numerical DESC\n`5`: Alphabetical Case Insensitive ASC\n`6`: Alphabetical Case Insensitive DESC' } }, + withSort(value): { sort: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['query', 'adhoc', 'constant', 'datasource', 'interval', 'textbox', 'custom', 'system'], name: 'value', type: ['string'] }], help: 'Dashboard variable type\n`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.\n`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).\n`constant`: \tDefine a hidden constant.\n`datasource`: Quickly change the data source for an entire dashboard.\n`interval`: Interval variables represent time spans.\n`textbox`: Display a free text input field with an optional default value.\n`custom`: Define the variable options manually using a comma-separated list.\n`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables' } }, + withType(value): { type: value }, + }, + }, + '#withTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Time range for dashboard.\nAccepted values are relative time strings like {from: 'now-6h', to: 'now'} or absolute time strings like {from: '2020-07-10T08:00:00.000Z', to: '2020-07-10T14:00:00.000Z'}." } }, + withTime(value): { time: value }, + '#withTimeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Time range for dashboard.\nAccepted values are relative time strings like {from: 'now-6h', to: 'now'} or absolute time strings like {from: '2020-07-10T08:00:00.000Z', to: '2020-07-10T14:00:00.000Z'}." } }, + withTimeMixin(value): { time+: value }, + time+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value='now-6h'): { time+: { from: value } }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTo(value='now'): { time+: { to: value } }, + }, + '#withTimepicker': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration of the time picker shown at the top of a dashboard.' } }, + withTimepicker(value): { timepicker: value }, + '#withTimepickerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration of the time picker shown at the top of a dashboard.' } }, + withTimepickerMixin(value): { timepicker+: value }, + timepicker+: + { + '#withCollapse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether timepicker is collapsed or not. Has no effect on provisioned dashboard.' } }, + withCollapse(value=true): { timepicker+: { collapse: value } }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether timepicker is visible or not.' } }, + withHidden(value=true): { timepicker+: { hidden: value } }, + '#withRefreshIntervals': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervals(value): { timepicker+: { refresh_intervals: (if std.isArray(value) + then value + else [value]) } }, + '#withRefreshIntervalsMixin': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervalsMixin(value): { timepicker+: { refresh_intervals+: (if std.isArray(value) + then value + else [value]) } }, + '#withTimeOptions': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptions(value): { timepicker+: { time_options: (if std.isArray(value) + then value + else [value]) } }, + '#withTimeOptionsMixin': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptionsMixin(value): { timepicker+: { time_options+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withTimezone': { 'function': { args: [{ default: 'browser', enums: null, name: 'value', type: ['string'] }], help: 'Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc".' } }, + withTimezone(value='browser'): { timezone: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title of dashboard.' } }, + withTitle(value): { title: value }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique dashboard identifier that can be generated by anyone. string (8-40)' } }, + withUid(value): { uid: value }, + '#withVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Version of the dashboard, incremented each time the dashboard is updated.' } }, + withVersion(value): { version: value }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday".' } }, + withWeekStart(value): { weekStart: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/folder.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/folder.libsonnet new file mode 100644 index 0000000..8667e08 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/folder.libsonnet @@ -0,0 +1,10 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.folder', name: 'folder' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of the folder.' } }, + withDescription(value): { description: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder title' } }, + withTitle(value): { title: value }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique folder id. (will be k8s name)' } }, + withUid(value): { uid: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/librarypanel.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/librarypanel.libsonnet new file mode 100644 index 0000000..eeb97e4 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/librarypanel.libsonnet @@ -0,0 +1,65 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.librarypanel', name: 'librarypanel' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description' } }, + withDescription(value): { description: value }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder UID' } }, + withFolderUid(value): { folderUid: value }, + '#withMeta': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMeta(value): { meta: value }, + '#withMetaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetaMixin(value): { meta+: value }, + meta+: + { + '#withConnectedDashboards': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withConnectedDashboards(value): { meta+: { connectedDashboards: value } }, + '#withCreated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCreated(value): { meta+: { created: value } }, + '#withCreatedBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCreatedBy(value): { meta+: { createdBy: value } }, + '#withCreatedByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCreatedByMixin(value): { meta+: { createdBy+: value } }, + createdBy+: + { + '#withAvatarUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAvatarUrl(value): { meta+: { createdBy+: { avatarUrl: value } } }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { meta+: { createdBy+: { id: value } } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { meta+: { createdBy+: { name: value } } }, + }, + '#withFolderName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderName(value): { meta+: { folderName: value } }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { meta+: { folderUid: value } }, + '#withUpdated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUpdated(value): { meta+: { updated: value } }, + '#withUpdatedBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdatedBy(value): { meta+: { updatedBy: value } }, + '#withUpdatedByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdatedByMixin(value): { meta+: { updatedBy+: value } }, + updatedBy+: + { + '#withAvatarUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAvatarUrl(value): { meta+: { updatedBy+: { avatarUrl: value } } }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { meta+: { updatedBy+: { id: value } } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { meta+: { updatedBy+: { name: value } } }, + }, + }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit;" } }, + withModel(value): { model: value }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit;" } }, + withModelMixin(value): { model+: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel name (also saved in the model)' } }, + withName(value): { name: value }, + '#withSchemaVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Dashboard version when this was saved (zero if unknown)' } }, + withSchemaVersion(value): { schemaVersion: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel type (from inside the model)' } }, + withType(value): { type: value }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library element UID' } }, + withUid(value): { uid: value }, + '#withVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'panel version, incremented each time the dashboard is updated.' } }, + withVersion(value): { version: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel.libsonnet new file mode 100644 index 0000000..9129691 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel.libsonnet @@ -0,0 +1,393 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { datasource: value }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { datasource+: value }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { type: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { datasource+: { uid: value } }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description.' } }, + withDescription(value): { description: value }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map a field to a color.' } }, + withColor(value): { fieldConfig+: { defaults+: { color: value } } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map a field to a color.' } }, + withColorMixin(value): { fieldConfig+: { defaults+: { color+: value } } }, + color+: + { + '#withFixedColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The fixed color value for fixed or shades color modes.' } }, + withFixedColor(value): { fieldConfig+: { defaults+: { color+: { fixedColor: value } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['thresholds', 'palette-classic', 'palette-classic-by-name', 'continuous-GrYlRd', 'continuous-RdYlGr', 'continuous-BlYlRd', 'continuous-YlRd', 'continuous-BlPu', 'continuous-YlBl', 'continuous-blues', 'continuous-reds', 'continuous-greens', 'continuous-purples', 'fixed', 'shades'], name: 'value', type: ['string'] }], help: 'Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations\n`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule.' } }, + withMode(value): { fieldConfig+: { defaults+: { color+: { mode: value } } } }, + '#withSeriesBy': { 'function': { args: [{ default: null, enums: ['min', 'max', 'last'], name: 'value', type: ['string'] }], help: 'Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.' } }, + withSeriesBy(value): { fieldConfig+: { defaults+: { color+: { seriesBy: value } } } }, + }, + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'custom is specified by the FieldConfig field\nin panel plugin schemas.' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'custom is specified by the FieldConfig field\nin panel plugin schemas.' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`.' } }, + withDecimals(value): { fieldConfig+: { defaults+: { decimals: value } } }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Human readable field metadata' } }, + withDescription(value): { fieldConfig+: { defaults+: { description: value } } }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The display value for this field. This supports template variables blank is auto' } }, + withDisplayName(value): { fieldConfig+: { defaults+: { displayName: value } } }, + '#withDisplayNameFromDS': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'This can be used by data sources that return and explicit naming structure for values and labels\nWhen this property is configured, this value is used rather than the default naming strategy.' } }, + withDisplayNameFromDS(value): { fieldConfig+: { defaults+: { displayNameFromDS: value } } }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source field supports ad-hoc filters' } }, + withFilterable(value=true): { fieldConfig+: { defaults+: { filterable: value } } }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinks(value): { fieldConfig+: { defaults+: { links: (if std.isArray(value) + then value + else [value]) } } }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinksMixin(value): { fieldConfig+: { defaults+: { links+: (if std.isArray(value) + then value + else [value]) } } }, + '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappings(value): { fieldConfig+: { defaults+: { mappings: (if std.isArray(value) + then value + else [value]) } } }, + '#withMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappingsMixin(value): { fieldConfig+: { defaults+: { mappings+: (if std.isArray(value) + then value + else [value]) } } }, + mappings+: + { + '#': { help: '', name: 'mappings' }, + ValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptionsMixin(value): { options+: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + RangeMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'null'] }], help: 'Min value of the range. It can be null which means -Infinity' } }, + withFrom(value): { options+: { from: value } }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { options+: { result: value } }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { options+: { result+: value } }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { options+: { result+: { color: value } } }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { options+: { result+: { icon: value } } }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { options+: { result+: { index: value } } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { options+: { result+: { text: value } } }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'null'] }], help: 'Max value of the range. It can be null which means +Infinity' } }, + withTo(value): { options+: { to: value } }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + RegexMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withPattern': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Regular expression to match against' } }, + withPattern(value): { options+: { pattern: value } }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { options+: { result: value } }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { options+: { result+: value } }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { options+: { result+: { color: value } } }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { options+: { result+: { icon: value } } }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { options+: { result+: { index: value } } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { options+: { result+: { text: value } } }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + SpecialValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withMatch': { 'function': { args: [{ default: null, enums: ['true', 'false', 'null', 'nan', 'null+nan', 'empty'], name: 'value', type: ['string'] }], help: 'Special value types supported by the `SpecialValueMap`' } }, + withMatch(value): { options+: { match: value } }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { options+: { result: value } }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { options+: { result+: value } }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { options+: { result+: { color: value } } }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { options+: { result+: { icon: value } } }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { options+: { result+: { index: value } } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { options+: { result+: { text: value } } }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMax(value): { fieldConfig+: { defaults+: { max: value } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMin(value): { fieldConfig+: { defaults+: { min: value } } }, + '#withNoValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alternative to empty string' } }, + withNoValue(value): { fieldConfig+: { defaults+: { noValue: value } } }, + '#withPath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results' } }, + withPath(value): { fieldConfig+: { defaults+: { path: value } } }, + '#withThresholds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Thresholds configuration for the panel' } }, + withThresholds(value): { fieldConfig+: { defaults+: { thresholds: value } } }, + '#withThresholdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Thresholds configuration for the panel' } }, + withThresholdsMixin(value): { fieldConfig+: { defaults+: { thresholds+: value } } }, + thresholds+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['absolute', 'percentage'], name: 'value', type: ['string'] }], help: 'Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).' } }, + withMode(value): { fieldConfig+: { defaults+: { thresholds+: { mode: value } } } }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withSteps(value): { fieldConfig+: { defaults+: { thresholds+: { steps: (if std.isArray(value) + then value + else [value]) } } } }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withStepsMixin(value): { fieldConfig+: { defaults+: { thresholds+: { steps+: (if std.isArray(value) + then value + else [value]) } } } }, + steps+: + { + '#': { help: '', name: 'steps' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.' } }, + withColor(value): { color: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'null'] }], help: 'Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON.' } }, + withValue(value): { value: value }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:` for custom unit that should go after value.\n`prefix:` for custom unit that should go before value.\n`time:` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.\n`count:` for a custom count unit.\n`currency:` for custom a currency unit.' } }, + withUnit(value): { fieldConfig+: { defaults+: { unit: value } } }, + '#withWriteable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source can write a value to the path. Auth/authz are supported separately' } }, + withWriteable(value=true): { fieldConfig+: { defaults+: { writeable: value } } }, + }, + '#withOverrides': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverrides(value): { fieldConfig+: { overrides: (if std.isArray(value) + then value + else [value]) } }, + '#withOverridesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverridesMixin(value): { fieldConfig+: { overrides+: (if std.isArray(value) + then value + else [value]) } }, + overrides+: + { + '#': { help: '', name: 'overrides' }, + '#withMatcher': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcher(value): { matcher: value }, + '#withMatcherMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcherMixin(value): { matcher+: value }, + matcher+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { matcher+: { id: value } }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { matcher+: { options: value } }, + }, + '#withProperties': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withProperties(value): { properties: (if std.isArray(value) + then value + else [value]) }, + '#withPropertiesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPropertiesMixin(value): { properties+: (if std.isArray(value) + then value + else [value]) }, + properties+: + { + '#': { help: '', name: 'properties' }, + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value=''): { id: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { value: value }, + }, + }, + }, + '#withGridPos': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPos(value): { gridPos: value }, + '#withGridPosMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPosMixin(value): { gridPos+: value }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { gridPos+: { h: value } }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { gridPos+: { static: value } }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { gridPos+: { w: value } }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { gridPos+: { x: value } }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { gridPos+: { y: value } }, + }, + '#withHideTimeOverride': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the timeFrom or timeShift overrides are shown in the panel header' } }, + withHideTimeOverride(value=true): { hideTimeOverride: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally.' } }, + withId(value): { id: value }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: "40s", "3d", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withInterval(value): { interval: value }, + '#withLibraryPanel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A library panel is a reusable panel that you can use in any dashboard.\nWhen you make a change to a library panel, that change propagates to all instances of where the panel is used.\nLibrary panels streamline reuse of panels across multiple dashboards.' } }, + withLibraryPanel(value): { libraryPanel: value }, + '#withLibraryPanelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A library panel is a reusable panel that you can use in any dashboard.\nWhen you make a change to a library panel, that change propagates to all instances of where the panel is used.\nLibrary panels streamline reuse of panels across multiple dashboards.' } }, + withLibraryPanelMixin(value): { libraryPanel+: value }, + libraryPanel+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel name' } }, + withName(value): { libraryPanel+: { name: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel uid' } }, + withUid(value): { libraryPanel+: { uid: value } }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinks(value): { links: (if std.isArray(value) + then value + else [value]) }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinksMixin(value): { links+: (if std.isArray(value) + then value + else [value]) }, + links+: + { + '#': { help: '', name: 'links' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { asDropdown: value }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { icon: value }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { includeVars: value }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { keepTime: value }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { tags: (if std.isArray(value) + then value + else [value]) }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { tags+: (if std.isArray(value) + then value + else [value]) }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { targetBlank: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { title: value }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { tooltip: value }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { type: value }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { url: value }, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum number of data points that the panel queries are retrieving.' } }, + withMaxDataPoints(value): { maxDataPoints: value }, + '#withMaxPerRow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Option for repeated panels that controls max items per row\nOnly relevant for horizontally repeated panels' } }, + withMaxPerRow(value): { maxPerRow: value }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.' } }, + withOptionsMixin(value): { options+: value }, + '#withPluginVersion': { 'function': { args: [], help: '' } }, + withPluginVersion(): { pluginVersion: 'v10.2.0' }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { repeat: value }, + '#withRepeatDirection': { 'function': { args: [{ default: 'h', enums: ['h', 'v'], name: 'value', type: ['string'] }], help: "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical." } }, + withRepeatDirection(value='h'): { repeatDirection: value }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags for the panel.' } }, + withTags(value): { tags: (if std.isArray(value) + then value + else [value]) }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags for the panel.' } }, + withTagsMixin(value): { tags+: (if std.isArray(value) + then value + else [value]) }, + '#withTargets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargets(value): { targets: (if std.isArray(value) + then value + else [value]) }, + '#withTargetsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargetsMixin(value): { targets+: (if std.isArray(value) + then value + else [value]) }, + '#withTimeFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeFrom(value): { timeFrom: value }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeShift(value): { timeShift: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel title.' } }, + withTitle(value): { title: value }, + '#withTransformations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformations(value): { transformations: (if std.isArray(value) + then value + else [value]) }, + '#withTransformationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformationsMixin(value): { transformations+: (if std.isArray(value) + then value + else [value]) }, + transformations+: + { + '#': { help: '', name: 'transformations' }, + '#withDisabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Disabled transformations are skipped' } }, + withDisabled(value=true): { disabled: value }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilter(value): { filter: value }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilterMixin(value): { filter+: value }, + filter+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { filter+: { id: value } }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { filter+: { options: value } }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique identifier of transformer' } }, + withId(value): { id: value }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptions(value): { options: value }, + }, + '#withTransparent': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether to display the panel without a background.' } }, + withTransparent(value=true): { transparent: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel plugin type id. This is used to find the plugin to display the panel.' } }, + withType(value): { type: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/alertGroups.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/alertGroups.libsonnet new file mode 100644 index 0000000..9cc6691 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/alertGroups.libsonnet @@ -0,0 +1,19 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.alertGroups', name: 'alertGroups' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withAlertmanager': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the alertmanager used as a source for alerts' } }, + withAlertmanager(value): { options+: { alertmanager: value } }, + '#withExpandAll': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Expand all alert groups by default' } }, + withExpandAll(value=true): { options+: { expandAll: value } }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Comma-separated list of values used to filter alert results' } }, + withLabels(value): { options+: { labels: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'alertGroups' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/alertList.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/alertList.libsonnet new file mode 100644 index 0000000..e5d9903 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/alertList.libsonnet @@ -0,0 +1,124 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.alertList', name: 'alertList' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptions(value): { options+: { AlertListOptions: value } }, + '#withAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptionsMixin(value): { options+: { AlertListOptions+: value } }, + AlertListOptions+: + { + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { options+: { alertName: value } }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { options+: { dashboardAlerts: value } }, + '#withDashboardTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDashboardTitle(value): { options+: { dashboardTitle: value } }, + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFolderId(value): { options+: { folderId: value } }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { options+: { maxItems: value } }, + '#withShowOptions': { 'function': { args: [{ default: null, enums: ['current', 'changes'], name: 'value', type: ['string'] }], help: '' } }, + withShowOptions(value): { options+: { showOptions: value } }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { options+: { sortOrder: value } }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { options+: { stateFilter: value } }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { options+: { stateFilter+: value } }, + stateFilter+: + { + '#withAlerting': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAlerting(value=true): { options+: { stateFilter+: { alerting: value } } }, + '#withExecutionError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withExecutionError(value=true): { options+: { stateFilter+: { execution_error: value } } }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { options+: { stateFilter+: { no_data: value } } }, + '#withOk': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOk(value=true): { options+: { stateFilter+: { ok: value } } }, + '#withPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPaused(value=true): { options+: { stateFilter+: { paused: value } } }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { options+: { stateFilter+: { pending: value } } }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { options+: { tags: (if std.isArray(value) + then value + else [value]) } }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { options+: { tags+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withUnifiedAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptions(value): { options+: { UnifiedAlertListOptions: value } }, + '#withUnifiedAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptionsMixin(value): { options+: { UnifiedAlertListOptions+: value } }, + UnifiedAlertListOptions+: + { + '#withAlertInstanceLabelFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertInstanceLabelFilter(value): { options+: { alertInstanceLabelFilter: value } }, + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { options+: { alertName: value } }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { options+: { dashboardAlerts: value } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDatasource(value): { options+: { datasource: value } }, + '#withFolder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolder(value): { options+: { folder: value } }, + '#withFolderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolderMixin(value): { options+: { folder+: value } }, + folder+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withId(value): { options+: { folder+: { id: value } } }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { options+: { folder+: { title: value } } }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { options+: { groupBy: (if std.isArray(value) + then value + else [value]) } }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { options+: { groupBy+: (if std.isArray(value) + then value + else [value]) } }, + '#withGroupMode': { 'function': { args: [{ default: null, enums: ['default', 'custom'], name: 'value', type: ['string'] }], help: '' } }, + withGroupMode(value): { options+: { groupMode: value } }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { options+: { maxItems: value } }, + '#withShowInstances': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowInstances(value=true): { options+: { showInstances: value } }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { options+: { sortOrder: value } }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { options+: { stateFilter: value } }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { options+: { stateFilter+: value } }, + stateFilter+: + { + '#withError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withError(value=true): { options+: { stateFilter+: { 'error': value } } }, + '#withFiring': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFiring(value=true): { options+: { stateFilter+: { firing: value } } }, + '#withInactive': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInactive(value=true): { options+: { stateFilter+: { inactive: value } } }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { options+: { stateFilter+: { noData: value } } }, + '#withNormal': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNormal(value=true): { options+: { stateFilter+: { normal: value } } }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { options+: { stateFilter+: { pending: value } } }, + }, + '#withViewMode': { 'function': { args: [{ default: null, enums: ['list', 'stat'], name: 'value', type: ['string'] }], help: '' } }, + withViewMode(value): { options+: { viewMode: value } }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'alertlist' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/annotationsList.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/annotationsList.libsonnet new file mode 100644 index 0000000..54d6770 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/annotationsList.libsonnet @@ -0,0 +1,39 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.annotationsList', name: 'annotationsList' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withLimit': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLimit(value=10): { options+: { limit: value } }, + '#withNavigateAfter': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateAfter(value='10m'): { options+: { navigateAfter: value } }, + '#withNavigateBefore': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateBefore(value='10m'): { options+: { navigateBefore: value } }, + '#withNavigateToPanel': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNavigateToPanel(value=true): { options+: { navigateToPanel: value } }, + '#withOnlyFromThisDashboard': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyFromThisDashboard(value=true): { options+: { onlyFromThisDashboard: value } }, + '#withOnlyInTimeRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyInTimeRange(value=true): { options+: { onlyInTimeRange: value } }, + '#withShowTags': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTags(value=true): { options+: { showTags: value } }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { options+: { showTime: value } }, + '#withShowUser': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUser(value=true): { options+: { showUser: value } }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { options+: { tags: (if std.isArray(value) + then value + else [value]) } }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { options+: { tags+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'annolist' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/barChart.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/barChart.libsonnet new file mode 100644 index 0000000..25da5b0 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/barChart.libsonnet @@ -0,0 +1,170 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.barChart', name: 'barChart' }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.\nGradient appearance is influenced by the Fill opacity setting.' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle: value } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: value } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: { mode: value } } } } }, + }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withBarRadius': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Controls the radius of each bar.' } }, + withBarRadius(value=0): { options+: { barRadius: value } }, + '#withBarWidth': { 'function': { args: [{ default: 0.96999999999999997, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of bars. 1 = Max width, 0 = Min width.' } }, + withBarWidth(value=0.96999999999999997): { options+: { barWidth: value } }, + '#withColorByField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use the color value for a sibling field to color each bar value.' } }, + withColorByField(value): { options+: { colorByField: value } }, + '#withFullHighlight': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enables mode which highlights the entire bar area and shows tooltip when cursor\nhovers over highlighted area' } }, + withFullHighlight(value=true): { options+: { fullHighlight: value } }, + '#withGroupWidth': { 'function': { args: [{ default: 0.69999999999999996, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of groups. 1 = max with, 0 = min width.' } }, + withGroupWidth(value=0.69999999999999996): { options+: { groupWidth: value } }, + '#withOrientation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the orientation of the bar chart, either vertical or horizontal.' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withShowValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'This controls whether values are shown on top or to the left of bars.' } }, + withShowValue(value): { options+: { showValue: value } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls whether bars are stacked or not, either normally or in percent mode.' } }, + withStacking(value): { options+: { stacking: value } }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Manually select which field from the dataset to represent the x field.' } }, + withXField(value): { options+: { xField: value } }, + '#withXTickLabelMaxLength': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the max length that a label can have before it is truncated.' } }, + withXTickLabelMaxLength(value): { options+: { xTickLabelMaxLength: value } }, + '#withXTickLabelRotation': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the rotation of the x axis labels.' } }, + withXTickLabelRotation(value=0): { options+: { xTickLabelRotation: value } }, + '#withXTickLabelSpacing': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the spacing between x axis labels.\nnegative values indicate backwards skipping behavior' } }, + withXTickLabelSpacing(value=0): { options+: { xTickLabelSpacing: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'barchart' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/barGauge.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/barGauge.libsonnet new file mode 100644 index 0000000..796ee70 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/barGauge.libsonnet @@ -0,0 +1,59 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.barGauge', name: 'barGauge' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { options+: { reduceOptions: value } }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { options+: { reduceOptions+: value } }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { options+: { reduceOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { options+: { reduceOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { options+: { reduceOptions+: { fields: value } } }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { options+: { reduceOptions+: { limit: value } } }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { options+: { reduceOptions+: { values: value } } }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withDisplayMode(value): { options+: { displayMode: value } }, + '#withMinVizHeight': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=10): { options+: { minVizHeight: value } }, + '#withMinVizWidth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=0): { options+: { minVizWidth: value } }, + '#withNamePlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'left'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge name to be placed explicitly' } }, + withNamePlacement(value): { options+: { namePlacement: value } }, + '#withShowUnfilled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUnfilled(value=true): { options+: { showUnfilled: value } }, + '#withValueMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueMode(value): { options+: { valueMode: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'bargauge' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/candlestick.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/candlestick.libsonnet new file mode 100644 index 0000000..d8239fe --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/candlestick.libsonnet @@ -0,0 +1,263 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.candlestick', name: 'candlestick' }, + '#withCandleStyle': { 'function': { args: [{ default: null, enums: ['candles', 'ohlcbars'], name: 'value', type: ['string'] }], help: '' } }, + withCandleStyle(value): { CandleStyle: value }, + '#withCandlestickColors': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCandlestickColors(value): { CandlestickColors: value }, + '#withCandlestickColorsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCandlestickColorsMixin(value): { CandlestickColors+: value }, + CandlestickColors+: + { + '#withDown': { 'function': { args: [{ default: 'red', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDown(value='red'): { CandlestickColors+: { down: value } }, + '#withFlat': { 'function': { args: [{ default: 'gray', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFlat(value='gray'): { CandlestickColors+: { flat: value } }, + '#withUp': { 'function': { args: [{ default: 'green', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUp(value='green'): { CandlestickColors+: { up: value } }, + }, + '#withCandlestickFieldMap': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCandlestickFieldMap(value): { CandlestickFieldMap: value }, + '#withCandlestickFieldMapMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCandlestickFieldMapMixin(value): { CandlestickFieldMap+: value }, + CandlestickFieldMap+: + { + '#withClose': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the final (end) value of the given period' } }, + withClose(value): { CandlestickFieldMap+: { close: value } }, + '#withHigh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the highest value of the given period' } }, + withHigh(value): { CandlestickFieldMap+: { high: value } }, + '#withLow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the lowest value of the given period' } }, + withLow(value): { CandlestickFieldMap+: { low: value } }, + '#withOpen': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the starting value of the given period' } }, + withOpen(value): { CandlestickFieldMap+: { open: value } }, + '#withVolume': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the sample count in the given period. (e.g. number of trades)' } }, + withVolume(value): { CandlestickFieldMap+: { volume: value } }, + }, + '#withColorStrategy': { 'function': { args: [{ default: null, enums: ['open-close', 'close-close'], name: 'value', type: ['string'] }], help: '' } }, + withColorStrategy(value): { ColorStrategy: value }, + '#withVizDisplayMode': { 'function': { args: [{ default: null, enums: ['candles+volume', 'candles', 'volume'], name: 'value', type: ['string'] }], help: '' } }, + withVizDisplayMode(value): { VizDisplayMode: value }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { lineColor: value } } } }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { fieldConfig+: { defaults+: { custom+: { lineInterpolation: value } } } }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { lineStyle: value } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: value } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { fill: value } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { fieldConfig+: { defaults+: { custom+: { spanNulls: value } } } }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { fieldConfig+: { defaults+: { custom+: { spanNulls+: value } } } }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { fieldConfig+: { defaults+: { custom+: { fillBelowTo: value } } } }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { fieldConfig+: { defaults+: { custom+: { fillColor: value } } } }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { pointColor: value } } } }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { pointSize: value } } } }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { fieldConfig+: { defaults+: { custom+: { pointSymbol: value } } } }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { fieldConfig+: { defaults+: { custom+: { showPoints: value } } } }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['integer'] }], help: 'TODO docs' } }, + withBarAlignment(value): { fieldConfig+: { defaults+: { custom+: { barAlignment: value } } } }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { fieldConfig+: { defaults+: { custom+: { barMaxWidth: value } } } }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { fieldConfig+: { defaults+: { custom+: { barWidthFactor: value } } } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { fieldConfig+: { defaults+: { custom+: { stacking: value } } } }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { fieldConfig+: { defaults+: { custom+: { stacking+: value } } } }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { group: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { mode: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { fieldConfig+: { defaults+: { custom+: { drawStyle: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle: value } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: value } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: { mode: value } } } } }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { fieldConfig+: { defaults+: { custom+: { transform: value } } } }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withCandleStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the style of the candlesticks' } }, + withCandleStyle(value): { options+: { candleStyle: value } }, + '#withColorStrategy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the color strategy for the candlesticks' } }, + withColorStrategy(value): { options+: { colorStrategy: value } }, + '#withColors': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColors(value): { options+: { colors: value } }, + '#withColorsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorsMixin(value): { options+: { colors+: value } }, + colors+: + { + '#withDown': { 'function': { args: [{ default: 'red', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDown(value='red'): { options+: { colors+: { down: value } } }, + '#withFlat': { 'function': { args: [{ default: 'gray', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFlat(value='gray'): { options+: { colors+: { flat: value } } }, + '#withUp': { 'function': { args: [{ default: 'green', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUp(value='green'): { options+: { colors+: { up: value } } }, + }, + '#withFields': { 'function': { args: [{ default: {}, enums: null, name: 'value', type: ['object'] }], help: 'Map fields to appropriate dimension' } }, + withFields(value={}): { options+: { fields: value } }, + '#withFieldsMixin': { 'function': { args: [{ default: {}, enums: null, name: 'value', type: ['object'] }], help: 'Map fields to appropriate dimension' } }, + withFieldsMixin(value): { options+: { fields+: value } }, + fields+: + { + '#withCandlestickFieldMap': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCandlestickFieldMap(value): { options+: { fields+: { CandlestickFieldMap: value } } }, + '#withCandlestickFieldMapMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCandlestickFieldMapMixin(value): { options+: { fields+: { CandlestickFieldMap+: value } } }, + CandlestickFieldMap+: + { + '#withClose': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the final (end) value of the given period' } }, + withClose(value): { options+: { fields+: { close: value } } }, + '#withHigh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the highest value of the given period' } }, + withHigh(value): { options+: { fields+: { high: value } } }, + '#withLow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the lowest value of the given period' } }, + withLow(value): { options+: { fields+: { low: value } } }, + '#withOpen': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the starting value of the given period' } }, + withOpen(value): { options+: { fields+: { open: value } } }, + '#withVolume': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the sample count in the given period. (e.g. number of trades)' } }, + withVolume(value): { options+: { fields+: { volume: value } } }, + }, + }, + '#withIncludeAllFields': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled, all fields will be sent to the graph' } }, + withIncludeAllFields(value=true): { options+: { includeAllFields: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets which dimensions are used for the visualization' } }, + withMode(value): { options+: { mode: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'candlestick' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/canvas.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/canvas.libsonnet new file mode 100644 index 0000000..95bbf50 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/canvas.libsonnet @@ -0,0 +1,522 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.canvas', name: 'canvas' }, + '#withBackgroundConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackgroundConfig(value): { BackgroundConfig: value }, + '#withBackgroundConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackgroundConfigMixin(value): { BackgroundConfig+: value }, + BackgroundConfig+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { BackgroundConfig+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { BackgroundConfig+: { color+: value } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { BackgroundConfig+: { color+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { BackgroundConfig+: { color+: { fixed: value } } }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImage(value): { BackgroundConfig+: { image: value } }, + '#withImageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImageMixin(value): { BackgroundConfig+: { image+: value } }, + image+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { BackgroundConfig+: { image+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { BackgroundConfig+: { image+: { fixed: value } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'mapping'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { BackgroundConfig+: { image+: { mode: value } } }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: ['original', 'contain', 'cover', 'fill', 'tile'], name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { BackgroundConfig+: { size: value } }, + }, + '#withBackgroundImageSize': { 'function': { args: [{ default: null, enums: ['original', 'contain', 'cover', 'fill', 'tile'], name: 'value', type: ['string'] }], help: '' } }, + withBackgroundImageSize(value): { BackgroundImageSize: value }, + '#withCanvasConnection': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCanvasConnection(value): { CanvasConnection: value }, + '#withCanvasConnectionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCanvasConnectionMixin(value): { CanvasConnection+: value }, + CanvasConnection+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { CanvasConnection+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { CanvasConnection+: { color+: value } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { CanvasConnection+: { color+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { CanvasConnection+: { color+: { fixed: value } } }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: ['straight'], name: 'value', type: ['string'] }], help: '' } }, + withPath(value): { CanvasConnection+: { path: value } }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSize(value): { CanvasConnection+: { size: value } }, + '#withSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSizeMixin(value): { CanvasConnection+: { size+: value } }, + size+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { CanvasConnection+: { size+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { CanvasConnection+: { size+: { fixed: value } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { CanvasConnection+: { size+: { max: value } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { CanvasConnection+: { size+: { min: value } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { CanvasConnection+: { size+: { mode: value } } }, + }, + '#withSource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSource(value): { CanvasConnection+: { source: value } }, + '#withSourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceMixin(value): { CanvasConnection+: { source+: value } }, + source+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { CanvasConnection+: { source+: { x: value } } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { CanvasConnection+: { source+: { y: value } } }, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTarget(value): { CanvasConnection+: { target: value } }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetMixin(value): { CanvasConnection+: { target+: value } }, + target+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { CanvasConnection+: { target+: { x: value } } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { CanvasConnection+: { target+: { y: value } } }, + }, + '#withTargetName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTargetName(value): { CanvasConnection+: { targetName: value } }, + }, + '#withCanvasElementOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCanvasElementOptions(value): { CanvasElementOptions: value }, + '#withCanvasElementOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCanvasElementOptionsMixin(value): { CanvasElementOptions+: value }, + CanvasElementOptions+: + { + '#withBackground': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackground(value): { CanvasElementOptions+: { background: value } }, + '#withBackgroundMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackgroundMixin(value): { CanvasElementOptions+: { background+: value } }, + background+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { CanvasElementOptions+: { background+: { color: value } } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { CanvasElementOptions+: { background+: { color+: value } } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { CanvasElementOptions+: { background+: { color+: { field: value } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { CanvasElementOptions+: { background+: { color+: { fixed: value } } } }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImage(value): { CanvasElementOptions+: { background+: { image: value } } }, + '#withImageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImageMixin(value): { CanvasElementOptions+: { background+: { image+: value } } }, + image+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { CanvasElementOptions+: { background+: { image+: { field: value } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { CanvasElementOptions+: { background+: { image+: { fixed: value } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'mapping'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { CanvasElementOptions+: { background+: { image+: { mode: value } } } }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: ['original', 'contain', 'cover', 'fill', 'tile'], name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { CanvasElementOptions+: { background+: { size: value } } }, + }, + '#withBorder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorder(value): { CanvasElementOptions+: { border: value } }, + '#withBorderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorderMixin(value): { CanvasElementOptions+: { border+: value } }, + border+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { CanvasElementOptions+: { border+: { color: value } } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { CanvasElementOptions+: { border+: { color+: value } } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { CanvasElementOptions+: { border+: { color+: { field: value } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { CanvasElementOptions+: { border+: { color+: { fixed: value } } } }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { CanvasElementOptions+: { border+: { width: value } } }, + }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfig(value): { CanvasElementOptions+: { config: value } }, + '#withConnections': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnections(value): { CanvasElementOptions+: { connections: (if std.isArray(value) + then value + else [value]) } }, + '#withConnectionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnectionsMixin(value): { CanvasElementOptions+: { connections+: (if std.isArray(value) + then value + else [value]) } }, + connections+: + { + '#': { help: '', name: 'connections' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { color: value }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { color+: value }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { color+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { color+: { fixed: value } }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: ['straight'], name: 'value', type: ['string'] }], help: '' } }, + withPath(value): { path: value }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSize(value): { size: value }, + '#withSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSizeMixin(value): { size+: value }, + size+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { size+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { size+: { fixed: value } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { size+: { max: value } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { size+: { min: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { size+: { mode: value } }, + }, + '#withSource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSource(value): { source: value }, + '#withSourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceMixin(value): { source+: value }, + source+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { source+: { x: value } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { source+: { y: value } }, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTarget(value): { target: value }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetMixin(value): { target+: value }, + target+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { target+: { x: value } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { target+: { y: value } }, + }, + '#withTargetName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTargetName(value): { targetName: value }, + }, + '#withConstraint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraint(value): { CanvasElementOptions+: { constraint: value } }, + '#withConstraintMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraintMixin(value): { CanvasElementOptions+: { constraint+: value } }, + constraint+: + { + '#withHorizontal': { 'function': { args: [{ default: null, enums: ['left', 'right', 'leftright', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withHorizontal(value): { CanvasElementOptions+: { constraint+: { horizontal: value } } }, + '#withVertical': { 'function': { args: [{ default: null, enums: ['top', 'bottom', 'topbottom', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withVertical(value): { CanvasElementOptions+: { constraint+: { vertical: value } } }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { CanvasElementOptions+: { name: value } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacement(value): { CanvasElementOptions+: { placement: value } }, + '#withPlacementMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacementMixin(value): { CanvasElementOptions+: { placement+: value } }, + placement+: + { + '#withBottom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBottom(value): { CanvasElementOptions+: { placement+: { bottom: value } } }, + '#withHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withHeight(value): { CanvasElementOptions+: { placement+: { height: value } } }, + '#withLeft': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLeft(value): { CanvasElementOptions+: { placement+: { left: value } } }, + '#withRight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRight(value): { CanvasElementOptions+: { placement+: { right: value } } }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTop(value): { CanvasElementOptions+: { placement+: { top: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { CanvasElementOptions+: { placement+: { width: value } } }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { CanvasElementOptions+: { type: value } }, + }, + '#withConnectionCoordinates': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConnectionCoordinates(value): { ConnectionCoordinates: value }, + '#withConnectionCoordinatesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConnectionCoordinatesMixin(value): { ConnectionCoordinates+: value }, + ConnectionCoordinates+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { ConnectionCoordinates+: { x: value } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { ConnectionCoordinates+: { y: value } }, + }, + '#withConnectionPath': { 'function': { args: [{ default: null, enums: ['straight'], name: 'value', type: ['string'] }], help: '' } }, + withConnectionPath(value): { ConnectionPath: value }, + '#withConstraint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraint(value): { Constraint: value }, + '#withConstraintMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraintMixin(value): { Constraint+: value }, + Constraint+: + { + '#withHorizontal': { 'function': { args: [{ default: null, enums: ['left', 'right', 'leftright', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withHorizontal(value): { Constraint+: { horizontal: value } }, + '#withVertical': { 'function': { args: [{ default: null, enums: ['top', 'bottom', 'topbottom', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withVertical(value): { Constraint+: { vertical: value } }, + }, + '#withHorizontalConstraint': { 'function': { args: [{ default: null, enums: ['left', 'right', 'leftright', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withHorizontalConstraint(value): { HorizontalConstraint: value }, + '#withHttpRequestMethod': { 'function': { args: [{ default: null, enums: ['GET', 'POST'], name: 'value', type: ['string'] }], help: '' } }, + withHttpRequestMethod(value): { HttpRequestMethod: value }, + '#withLineConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineConfig(value): { LineConfig: value }, + '#withLineConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineConfigMixin(value): { LineConfig+: value }, + LineConfig+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { LineConfig+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { LineConfig+: { color+: value } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { LineConfig+: { color+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { LineConfig+: { color+: { fixed: value } } }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { LineConfig+: { width: value } }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacement(value): { Placement: value }, + '#withPlacementMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacementMixin(value): { Placement+: value }, + Placement+: + { + '#withBottom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBottom(value): { Placement+: { bottom: value } }, + '#withHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withHeight(value): { Placement+: { height: value } }, + '#withLeft': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLeft(value): { Placement+: { left: value } }, + '#withRight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRight(value): { Placement+: { right: value } }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTop(value): { Placement+: { top: value } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { Placement+: { width: value } }, + }, + '#withVerticalConstraint': { 'function': { args: [{ default: null, enums: ['top', 'bottom', 'topbottom', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withVerticalConstraint(value): { VerticalConstraint: value }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withInlineEditing': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable inline editing' } }, + withInlineEditing(value=true): { options+: { inlineEditing: value } }, + '#withRoot': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRoot(value): { options+: { root: value } }, + '#withRootMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRootMixin(value): { options+: { root+: value } }, + root+: + { + '#withElements': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElements(value): { options+: { root+: { elements: (if std.isArray(value) + then value + else [value]) } } }, + '#withElementsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElementsMixin(value): { options+: { root+: { elements+: (if std.isArray(value) + then value + else [value]) } } }, + elements+: + { + '#': { help: '', name: 'elements' }, + '#withBackground': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackground(value): { background: value }, + '#withBackgroundMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackgroundMixin(value): { background+: value }, + background+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { background+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { background+: { color+: value } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { background+: { color+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { background+: { color+: { fixed: value } } }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImage(value): { background+: { image: value } }, + '#withImageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImageMixin(value): { background+: { image+: value } }, + image+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { background+: { image+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { background+: { image+: { fixed: value } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'mapping'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { background+: { image+: { mode: value } } }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: ['original', 'contain', 'cover', 'fill', 'tile'], name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { background+: { size: value } }, + }, + '#withBorder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorder(value): { border: value }, + '#withBorderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorderMixin(value): { border+: value }, + border+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { border+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { border+: { color+: value } }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { border+: { color+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { border+: { color+: { fixed: value } } }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { border+: { width: value } }, + }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfig(value): { config: value }, + '#withConnections': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnections(value): { connections: (if std.isArray(value) + then value + else [value]) }, + '#withConnectionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnectionsMixin(value): { connections+: (if std.isArray(value) + then value + else [value]) }, + connections+: + { + '#': { help: '', name: 'connections' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { color: value }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { color+: value }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { color+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { color+: { fixed: value } }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: ['straight'], name: 'value', type: ['string'] }], help: '' } }, + withPath(value): { path: value }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSize(value): { size: value }, + '#withSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSizeMixin(value): { size+: value }, + size+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { size+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { size+: { fixed: value } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { size+: { max: value } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { size+: { min: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { size+: { mode: value } }, + }, + '#withSource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSource(value): { source: value }, + '#withSourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceMixin(value): { source+: value }, + source+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { source+: { x: value } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { source+: { y: value } }, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTarget(value): { target: value }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetMixin(value): { target+: value }, + target+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { target+: { x: value } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { target+: { y: value } }, + }, + '#withTargetName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTargetName(value): { targetName: value }, + }, + '#withConstraint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraint(value): { constraint: value }, + '#withConstraintMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraintMixin(value): { constraint+: value }, + constraint+: + { + '#withHorizontal': { 'function': { args: [{ default: null, enums: ['left', 'right', 'leftright', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withHorizontal(value): { constraint+: { horizontal: value } }, + '#withVertical': { 'function': { args: [{ default: null, enums: ['top', 'bottom', 'topbottom', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withVertical(value): { constraint+: { vertical: value } }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withPlacement': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacement(value): { placement: value }, + '#withPlacementMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacementMixin(value): { placement+: value }, + placement+: + { + '#withBottom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBottom(value): { placement+: { bottom: value } }, + '#withHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withHeight(value): { placement+: { height: value } }, + '#withLeft': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLeft(value): { placement+: { left: value } }, + '#withRight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRight(value): { placement+: { right: value } }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTop(value): { placement+: { top: value } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { placement+: { width: value } }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the root element' } }, + withName(value): { options+: { root+: { name: value } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['frame'], name: 'value', type: ['string'] }], help: 'Type of root element (frame)' } }, + withType(value): { options+: { root+: { type: value } } }, + }, + '#withShowAdvancedTypes': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show all available element types' } }, + withShowAdvancedTypes(value=true): { options+: { showAdvancedTypes: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'canvas' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/dashboardList.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/dashboardList.libsonnet new file mode 100644 index 0000000..bb94183 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/dashboardList.libsonnet @@ -0,0 +1,41 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.dashboardList', name: 'dashboardList' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'folderId is deprecated, and migrated to folderUid on panel init' } }, + withFolderId(value): { options+: { folderId: value } }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { options+: { folderUID: value } }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIncludeVars(value=true): { options+: { includeVars: value } }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withKeepTime(value=true): { options+: { keepTime: value } }, + '#withMaxItems': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxItems(value=10): { options+: { maxItems: value } }, + '#withQuery': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value=''): { options+: { query: value } }, + '#withShowHeadings': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowHeadings(value=true): { options+: { showHeadings: value } }, + '#withShowRecentlyViewed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowRecentlyViewed(value=true): { options+: { showRecentlyViewed: value } }, + '#withShowSearch': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowSearch(value=true): { options+: { showSearch: value } }, + '#withShowStarred': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowStarred(value=true): { options+: { showStarred: value } }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { options+: { tags: (if std.isArray(value) + then value + else [value]) } }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { options+: { tags+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'dashlist' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/datagrid.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/datagrid.libsonnet new file mode 100644 index 0000000..d63bda1 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/datagrid.libsonnet @@ -0,0 +1,15 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.datagrid', name: 'datagrid' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withSelectedSeries': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSelectedSeries(value=0): { options+: { selectedSeries: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'datagrid' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/debug.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/debug.libsonnet new file mode 100644 index 0000000..2038d7b --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/debug.libsonnet @@ -0,0 +1,43 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.debug', name: 'debug' }, + '#withDebugMode': { 'function': { args: [{ default: null, enums: ['render', 'events', 'cursor', 'State', 'ThrowError'], name: 'value', type: ['string'] }], help: '' } }, + withDebugMode(value): { DebugMode: value }, + '#withUpdateConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdateConfig(value): { UpdateConfig: value }, + '#withUpdateConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdateConfigMixin(value): { UpdateConfig+: value }, + UpdateConfig+: + { + '#withDataChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDataChanged(value=true): { UpdateConfig+: { dataChanged: value } }, + '#withRender': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRender(value=true): { UpdateConfig+: { render: value } }, + '#withSchemaChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSchemaChanged(value=true): { UpdateConfig+: { schemaChanged: value } }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withCounters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCounters(value): { options+: { counters: value } }, + '#withCountersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCountersMixin(value): { options+: { counters+: value } }, + counters+: + { + '#withDataChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDataChanged(value=true): { options+: { counters+: { dataChanged: value } } }, + '#withRender': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRender(value=true): { options+: { counters+: { render: value } } }, + '#withSchemaChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSchemaChanged(value=true): { options+: { counters+: { schemaChanged: value } } }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['render', 'events', 'cursor', 'State', 'ThrowError'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { mode: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'debug' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/gauge.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/gauge.libsonnet new file mode 100644 index 0000000..905c2d1 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/gauge.libsonnet @@ -0,0 +1,55 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.gauge', name: 'gauge' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { options+: { reduceOptions: value } }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { options+: { reduceOptions+: value } }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { options+: { reduceOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { options+: { reduceOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { options+: { reduceOptions+: { fields: value } } }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { options+: { reduceOptions+: { limit: value } } }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { options+: { reduceOptions+: { values: value } } }, + }, + '#withMinVizHeight': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=75): { options+: { minVizHeight: value } }, + '#withMinVizWidth': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=75): { options+: { minVizWidth: value } }, + '#withShowThresholdLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdLabels(value=true): { options+: { showThresholdLabels: value } }, + '#withShowThresholdMarkers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdMarkers(value=true): { options+: { showThresholdMarkers: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'gauge' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/geomap.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/geomap.libsonnet new file mode 100644 index 0000000..b04f202 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/geomap.libsonnet @@ -0,0 +1,216 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.geomap', name: 'geomap' }, + '#withControlsOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControlsOptions(value): { ControlsOptions: value }, + '#withControlsOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControlsOptionsMixin(value): { ControlsOptions+: value }, + ControlsOptions+: + { + '#withMouseWheelZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'let the mouse wheel zoom' } }, + withMouseWheelZoom(value=true): { ControlsOptions+: { mouseWheelZoom: value } }, + '#withShowAttribution': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Lower right' } }, + withShowAttribution(value=true): { ControlsOptions+: { showAttribution: value } }, + '#withShowDebug': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show debug' } }, + withShowDebug(value=true): { ControlsOptions+: { showDebug: value } }, + '#withShowMeasure': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show measure' } }, + withShowMeasure(value=true): { ControlsOptions+: { showMeasure: value } }, + '#withShowScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Scale options' } }, + withShowScale(value=true): { ControlsOptions+: { showScale: value } }, + '#withShowZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Zoom (upper left)' } }, + withShowZoom(value=true): { ControlsOptions+: { showZoom: value } }, + }, + '#withMapCenterID': { 'function': { args: [{ default: null, enums: ['zero', 'coords', 'fit'], name: 'value', type: ['string'] }], help: '' } }, + withMapCenterID(value): { MapCenterID: value }, + '#withMapViewConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMapViewConfig(value): { MapViewConfig: value }, + '#withMapViewConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMapViewConfigMixin(value): { MapViewConfig+: value }, + MapViewConfig+: + { + '#withAllLayers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAllLayers(value=true): { MapViewConfig+: { allLayers: value } }, + '#withId': { 'function': { args: [{ default: 'zero', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value='zero'): { MapViewConfig+: { id: value } }, + '#withLastOnly': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLastOnly(value=true): { MapViewConfig+: { lastOnly: value } }, + '#withLat': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLat(value=0): { MapViewConfig+: { lat: value } }, + '#withLayer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLayer(value): { MapViewConfig+: { layer: value } }, + '#withLon': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLon(value=0): { MapViewConfig+: { lon: value } }, + '#withMaxZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxZoom(value): { MapViewConfig+: { maxZoom: value } }, + '#withMinZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinZoom(value): { MapViewConfig+: { minZoom: value } }, + '#withPadding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withPadding(value): { MapViewConfig+: { padding: value } }, + '#withShared': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShared(value=true): { MapViewConfig+: { shared: value } }, + '#withZoom': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withZoom(value=1): { MapViewConfig+: { zoom: value } }, + }, + '#withTooltipMode': { 'function': { args: [{ default: null, enums: ['none', 'details'], name: 'value', type: ['string'] }], help: '' } }, + withTooltipMode(value): { TooltipMode: value }, + '#withTooltipOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltipOptions(value): { TooltipOptions: value }, + '#withTooltipOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltipOptionsMixin(value): { TooltipOptions+: value }, + TooltipOptions+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'details'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { TooltipOptions+: { mode: value } }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withBasemap': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemap(value): { options+: { basemap: value } }, + '#withBasemapMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemapMixin(value): { options+: { basemap+: value } }, + basemap+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { options+: { basemap+: { config: value } } }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { options+: { basemap+: { filterData: value } } }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocation(value): { options+: { basemap+: { location: value } } }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocationMixin(value): { options+: { basemap+: { location+: value } } }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { options+: { basemap+: { location+: { gazetteer: value } } } }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { options+: { basemap+: { location+: { geohash: value } } } }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { options+: { basemap+: { location+: { latitude: value } } } }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { options+: { basemap+: { location+: { longitude: value } } } }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { options+: { basemap+: { location+: { lookup: value } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { basemap+: { location+: { mode: value } } } }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { options+: { basemap+: { location+: { wkt: value } } } }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { options+: { basemap+: { name: value } } }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { options+: { basemap+: { opacity: value } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { options+: { basemap+: { tooltip: value } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { options+: { basemap+: { type: value } } }, + }, + '#withControls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControls(value): { options+: { controls: value } }, + '#withControlsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControlsMixin(value): { options+: { controls+: value } }, + controls+: + { + '#withMouseWheelZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'let the mouse wheel zoom' } }, + withMouseWheelZoom(value=true): { options+: { controls+: { mouseWheelZoom: value } } }, + '#withShowAttribution': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Lower right' } }, + withShowAttribution(value=true): { options+: { controls+: { showAttribution: value } } }, + '#withShowDebug': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show debug' } }, + withShowDebug(value=true): { options+: { controls+: { showDebug: value } } }, + '#withShowMeasure': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show measure' } }, + withShowMeasure(value=true): { options+: { controls+: { showMeasure: value } } }, + '#withShowScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Scale options' } }, + withShowScale(value=true): { options+: { controls+: { showScale: value } } }, + '#withShowZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Zoom (upper left)' } }, + withShowZoom(value=true): { options+: { controls+: { showZoom: value } } }, + }, + '#withLayers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayers(value): { options+: { layers: (if std.isArray(value) + then value + else [value]) } }, + '#withLayersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayersMixin(value): { options+: { layers+: (if std.isArray(value) + then value + else [value]) } }, + layers+: + { + '#': { help: '', name: 'layers' }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { config: value }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { filterData: value }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocation(value): { location: value }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocationMixin(value): { location+: value }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { location+: { gazetteer: value } }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { location+: { geohash: value } }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { location+: { latitude: value } }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { location+: { longitude: value } }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { location+: { lookup: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { location+: { mode: value } }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { location+: { wkt: value } }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { name: value }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { opacity: value }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { tooltip: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'details'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withView(value): { options+: { view: value } }, + '#withViewMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withViewMixin(value): { options+: { view+: value } }, + view+: + { + '#withAllLayers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAllLayers(value=true): { options+: { view+: { allLayers: value } } }, + '#withId': { 'function': { args: [{ default: 'zero', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value='zero'): { options+: { view+: { id: value } } }, + '#withLastOnly': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLastOnly(value=true): { options+: { view+: { lastOnly: value } } }, + '#withLat': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLat(value=0): { options+: { view+: { lat: value } } }, + '#withLayer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLayer(value): { options+: { view+: { layer: value } } }, + '#withLon': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLon(value=0): { options+: { view+: { lon: value } } }, + '#withMaxZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxZoom(value): { options+: { view+: { maxZoom: value } } }, + '#withMinZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinZoom(value): { options+: { view+: { minZoom: value } } }, + '#withPadding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withPadding(value): { options+: { view+: { padding: value } } }, + '#withShared': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShared(value=true): { options+: { view+: { shared: value } } }, + '#withZoom': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withZoom(value=1): { options+: { view+: { zoom: value } } }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'geomap' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/heatmap.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/heatmap.libsonnet new file mode 100644 index 0000000..cf12515 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/heatmap.libsonnet @@ -0,0 +1,418 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.heatmap', name: 'heatmap' }, + '#withCellValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValues(value): { CellValues: value }, + '#withCellValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValuesMixin(value): { CellValues+: value }, + CellValues+: + { + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for cell values' } }, + withDecimals(value): { CellValues+: { decimals: value } }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the cell value unit' } }, + withUnit(value): { CellValues+: { unit: value } }, + }, + '#withExemplarConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplarConfig(value): { ExemplarConfig: value }, + '#withExemplarConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplarConfigMixin(value): { ExemplarConfig+: value }, + ExemplarConfig+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the color of the exemplar markers' } }, + withColor(value): { ExemplarConfig+: { color: value } }, + }, + '#withFilterValueRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValueRange(value): { FilterValueRange: value }, + '#withFilterValueRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValueRangeMixin(value): { FilterValueRange+: value }, + FilterValueRange+: + { + '#withGe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values greater than or equal to the given value' } }, + withGe(value): { FilterValueRange+: { ge: value } }, + '#withLe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values less than or equal to the given value' } }, + withLe(value): { FilterValueRange+: { le: value } }, + }, + '#withHeatmapColorMode': { 'function': { args: [{ default: null, enums: ['opacity', 'scheme'], name: 'value', type: ['string'] }], help: 'Controls the color mode of the heatmap' } }, + withHeatmapColorMode(value): { HeatmapColorMode: value }, + '#withHeatmapColorOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withHeatmapColorOptions(value): { HeatmapColorOptions: value }, + '#withHeatmapColorOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withHeatmapColorOptionsMixin(value): { HeatmapColorOptions+: value }, + HeatmapColorOptions+: + { + '#withExponent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the exponent when scale is set to exponential' } }, + withExponent(value): { HeatmapColorOptions+: { exponent: value } }, + '#withFill': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color fill when in opacity mode' } }, + withFill(value): { HeatmapColorOptions+: { fill: value } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the color scale' } }, + withMax(value): { HeatmapColorOptions+: { max: value } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the color scale' } }, + withMin(value): { HeatmapColorOptions+: { min: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['opacity', 'scheme'], name: 'value', type: ['string'] }], help: 'Controls the color mode of the heatmap' } }, + withMode(value): { HeatmapColorOptions+: { mode: value } }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the color scheme' } }, + withReverse(value=true): { HeatmapColorOptions+: { reverse: value } }, + '#withScale': { 'function': { args: [{ default: null, enums: ['linear', 'exponential'], name: 'value', type: ['string'] }], help: 'Controls the color scale of the heatmap' } }, + withScale(value): { HeatmapColorOptions+: { scale: value } }, + '#withScheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color scheme used' } }, + withScheme(value): { HeatmapColorOptions+: { scheme: value } }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the number of color steps' } }, + withSteps(value): { HeatmapColorOptions+: { steps: value } }, + }, + '#withHeatmapColorScale': { 'function': { args: [{ default: null, enums: ['linear', 'exponential'], name: 'value', type: ['string'] }], help: 'Controls the color scale of the heatmap' } }, + withHeatmapColorScale(value): { HeatmapColorScale: value }, + '#withHeatmapLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withHeatmapLegend(value): { HeatmapLegend: value }, + '#withHeatmapLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withHeatmapLegendMixin(value): { HeatmapLegend+: value }, + HeatmapLegend+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the legend is shown' } }, + withShow(value=true): { HeatmapLegend+: { show: value } }, + }, + '#withHeatmapTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withHeatmapTooltip(value): { HeatmapTooltip: value }, + '#withHeatmapTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withHeatmapTooltipMixin(value): { HeatmapTooltip+: value }, + HeatmapTooltip+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip is shown' } }, + withShow(value=true): { HeatmapTooltip+: { show: value } }, + '#withYHistogram': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a histogram of the y-axis values' } }, + withYHistogram(value=true): { HeatmapTooltip+: { yHistogram: value } }, + }, + '#withRowsHeatmapOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsHeatmapOptions(value): { RowsHeatmapOptions: value }, + '#withRowsHeatmapOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsHeatmapOptionsMixin(value): { RowsHeatmapOptions+: value }, + RowsHeatmapOptions+: + { + '#withLayout': { 'function': { args: [{ default: null, enums: ['le', 'ge', 'unknown', 'auto'], name: 'value', type: ['string'] }], help: '' } }, + withLayout(value): { RowsHeatmapOptions+: { layout: value } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the name of the cell when not calculating from data' } }, + withValue(value): { RowsHeatmapOptions+: { value: value } }, + }, + '#withYAxisConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxisConfig(value): { YAxisConfig: value }, + '#withYAxisConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxisConfigMixin(value): { YAxisConfig+: value }, + YAxisConfig+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { YAxisConfig+: { axisBorderShow: value } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { YAxisConfig+: { axisCenteredZero: value } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { YAxisConfig+: { axisColorMode: value } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { YAxisConfig+: { axisGridShow: value } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { YAxisConfig+: { axisLabel: value } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { YAxisConfig+: { axisPlacement: value } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { YAxisConfig+: { axisSoftMax: value } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { YAxisConfig+: { axisSoftMin: value } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { YAxisConfig+: { axisWidth: value } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { YAxisConfig+: { scaleDistribution: value } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { YAxisConfig+: { scaleDistribution+: value } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { YAxisConfig+: { scaleDistribution+: { linearThreshold: value } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { YAxisConfig+: { scaleDistribution+: { log: value } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { YAxisConfig+: { scaleDistribution+: { type: value } } }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for yAxis values' } }, + withDecimals(value): { YAxisConfig+: { decimals: value } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the yAxis' } }, + withMax(value): { YAxisConfig+: { max: value } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the yAxis' } }, + withMin(value): { YAxisConfig+: { min: value } }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the yAxis' } }, + withReverse(value=true): { YAxisConfig+: { reverse: value } }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the yAxis unit' } }, + withUnit(value): { YAxisConfig+: { unit: value } }, + }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withCalculate': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the heatmap should be calculated from data' } }, + withCalculate(value=true): { options+: { calculate: value } }, + '#withCalculation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCalculation(value): { options+: { calculation: value } }, + '#withCalculationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCalculationMixin(value): { options+: { calculation+: value } }, + calculation+: + { + '#withXBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXBuckets(value): { options+: { calculation+: { xBuckets: value } } }, + '#withXBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXBucketsMixin(value): { options+: { calculation+: { xBuckets+: value } } }, + xBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { calculation+: { xBuckets+: { mode: value } } } }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { options+: { calculation+: { xBuckets+: { scale: value } } } }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { options+: { calculation+: { xBuckets+: { scale+: value } } } }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { options+: { calculation+: { xBuckets+: { scale+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { options+: { calculation+: { xBuckets+: { scale+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { options+: { calculation+: { xBuckets+: { scale+: { type: value } } } } }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { options+: { calculation+: { xBuckets+: { value: value } } } }, + }, + '#withYBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withYBuckets(value): { options+: { calculation+: { yBuckets: value } } }, + '#withYBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withYBucketsMixin(value): { options+: { calculation+: { yBuckets+: value } } }, + yBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { calculation+: { yBuckets+: { mode: value } } } }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { options+: { calculation+: { yBuckets+: { scale: value } } } }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { options+: { calculation+: { yBuckets+: { scale+: value } } } }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { options+: { calculation+: { yBuckets+: { scale+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { options+: { calculation+: { yBuckets+: { scale+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { options+: { calculation+: { yBuckets+: { scale+: { type: value } } } } }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { options+: { calculation+: { yBuckets+: { value: value } } } }, + }, + }, + '#withCellGap': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls gap between cells' } }, + withCellGap(value=1): { options+: { cellGap: value } }, + '#withCellRadius': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls cell radius' } }, + withCellRadius(value): { options+: { cellRadius: value } }, + '#withCellValues': { 'function': { args: [{ default: {}, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value unit' } }, + withCellValues(value={}): { options+: { cellValues: value } }, + '#withCellValuesMixin': { 'function': { args: [{ default: {}, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value unit' } }, + withCellValuesMixin(value): { options+: { cellValues+: value } }, + cellValues+: + { + '#withCellValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValues(value): { options+: { cellValues+: { CellValues: value } } }, + '#withCellValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValuesMixin(value): { options+: { cellValues+: { CellValues+: value } } }, + CellValues+: + { + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for cell values' } }, + withDecimals(value): { options+: { cellValues+: { decimals: value } } }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the cell value unit' } }, + withUnit(value): { options+: { cellValues+: { unit: value } } }, + }, + }, + '#withColor': { 'function': { args: [{ default: { exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }, enums: null, name: 'value', type: ['object'] }], help: 'Controls the color options' } }, + withColor(value={ exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }): { options+: { color: value } }, + '#withColorMixin': { 'function': { args: [{ default: { exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }, enums: null, name: 'value', type: ['object'] }], help: 'Controls the color options' } }, + withColorMixin(value): { options+: { color+: value } }, + color+: + { + '#withHeatmapColorOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withHeatmapColorOptions(value): { options+: { color+: { HeatmapColorOptions: value } } }, + '#withHeatmapColorOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withHeatmapColorOptionsMixin(value): { options+: { color+: { HeatmapColorOptions+: value } } }, + HeatmapColorOptions+: + { + '#withExponent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the exponent when scale is set to exponential' } }, + withExponent(value): { options+: { color+: { exponent: value } } }, + '#withFill': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color fill when in opacity mode' } }, + withFill(value): { options+: { color+: { fill: value } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the color scale' } }, + withMax(value): { options+: { color+: { max: value } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the color scale' } }, + withMin(value): { options+: { color+: { min: value } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['opacity', 'scheme'], name: 'value', type: ['string'] }], help: 'Controls the color mode of the heatmap' } }, + withMode(value): { options+: { color+: { mode: value } } }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the color scheme' } }, + withReverse(value=true): { options+: { color+: { reverse: value } } }, + '#withScale': { 'function': { args: [{ default: null, enums: ['linear', 'exponential'], name: 'value', type: ['string'] }], help: 'Controls the color scale of the heatmap' } }, + withScale(value): { options+: { color+: { scale: value } } }, + '#withScheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color scheme used' } }, + withScheme(value): { options+: { color+: { scheme: value } } }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the number of color steps' } }, + withSteps(value): { options+: { color+: { steps: value } } }, + }, + }, + '#withExemplars': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplars(value): { options+: { exemplars: value } }, + '#withExemplarsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplarsMixin(value): { options+: { exemplars+: value } }, + exemplars+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the color of the exemplar markers' } }, + withColor(value): { options+: { exemplars+: { color: value } } }, + }, + '#withFilterValues': { 'function': { args: [{ default: { le: 1.0000000000000001e-09 }, enums: null, name: 'value', type: ['object'] }], help: 'Filters values between a given range' } }, + withFilterValues(value={ le: 1.0000000000000001e-09 }): { options+: { filterValues: value } }, + '#withFilterValuesMixin': { 'function': { args: [{ default: { le: 1.0000000000000001e-09 }, enums: null, name: 'value', type: ['object'] }], help: 'Filters values between a given range' } }, + withFilterValuesMixin(value): { options+: { filterValues+: value } }, + filterValues+: + { + '#withFilterValueRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValueRange(value): { options+: { filterValues+: { FilterValueRange: value } } }, + '#withFilterValueRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValueRangeMixin(value): { options+: { filterValues+: { FilterValueRange+: value } } }, + FilterValueRange+: + { + '#withGe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values greater than or equal to the given value' } }, + withGe(value): { options+: { filterValues+: { ge: value } } }, + '#withLe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values less than or equal to the given value' } }, + withLe(value): { options+: { filterValues+: { le: value } } }, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the legend is shown' } }, + withShow(value=true): { options+: { legend+: { show: value } } }, + }, + '#withRowsFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrame(value): { options+: { rowsFrame: value } }, + '#withRowsFrameMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrameMixin(value): { options+: { rowsFrame+: value } }, + rowsFrame+: + { + '#withLayout': { 'function': { args: [{ default: null, enums: ['le', 'ge', 'unknown', 'auto'], name: 'value', type: ['string'] }], help: '' } }, + withLayout(value): { options+: { rowsFrame+: { layout: value } } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the name of the cell when not calculating from data' } }, + withValue(value): { options+: { rowsFrame+: { value: value } } }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '| *{\n\tlayout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed\n}\nControls the display of the value in the cell' } }, + withShowValue(value): { options+: { showValue: value } }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip is shown' } }, + withShow(value=true): { options+: { tooltip+: { show: value } } }, + '#withYHistogram': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a histogram of the y-axis values' } }, + withYHistogram(value=true): { options+: { tooltip+: { yHistogram: value } } }, + }, + '#withYAxis': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxis(value): { options+: { yAxis: value } }, + '#withYAxisMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxisMixin(value): { options+: { yAxis+: value } }, + yAxis+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { options+: { yAxis+: { axisBorderShow: value } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { options+: { yAxis+: { axisCenteredZero: value } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { options+: { yAxis+: { axisColorMode: value } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { options+: { yAxis+: { axisGridShow: value } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { options+: { yAxis+: { axisLabel: value } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { options+: { yAxis+: { axisPlacement: value } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { options+: { yAxis+: { axisSoftMax: value } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { options+: { yAxis+: { axisSoftMin: value } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { options+: { yAxis+: { axisWidth: value } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { options+: { yAxis+: { scaleDistribution: value } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { options+: { yAxis+: { scaleDistribution+: value } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { options+: { yAxis+: { scaleDistribution+: { linearThreshold: value } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { options+: { yAxis+: { scaleDistribution+: { log: value } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { options+: { yAxis+: { scaleDistribution+: { type: value } } } }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for yAxis values' } }, + withDecimals(value): { options+: { yAxis+: { decimals: value } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the yAxis' } }, + withMax(value): { options+: { yAxis+: { max: value } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the yAxis' } }, + withMin(value): { options+: { yAxis+: { min: value } } }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the yAxis' } }, + withReverse(value=true): { options+: { yAxis+: { reverse: value } } }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the yAxis unit' } }, + withUnit(value): { options+: { yAxis+: { unit: value } } }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'heatmap' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/histogram.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/histogram.libsonnet new file mode 100644 index 0000000..3250a2d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/histogram.libsonnet @@ -0,0 +1,132 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.histogram', name: 'histogram' }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.\nGradient appearance is influenced by the Fill opacity setting.' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withBucketOffset': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Offset buckets by this amount' } }, + withBucketOffset(value=0): { options+: { bucketOffset: value } }, + '#withBucketSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Size of each bucket' } }, + withBucketSize(value): { options+: { bucketSize: value } }, + '#withCombine': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Combines multiple series into a single histogram' } }, + withCombine(value=true): { options+: { combine: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'histogram' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/logs.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/logs.libsonnet new file mode 100644 index 0000000..c285dd0 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/logs.libsonnet @@ -0,0 +1,29 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.logs', name: 'logs' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withDedupStrategy': { 'function': { args: [{ default: null, enums: ['none', 'exact', 'numbers', 'signature'], name: 'value', type: ['string'] }], help: '' } }, + withDedupStrategy(value): { options+: { dedupStrategy: value } }, + '#withEnableLogDetails': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnableLogDetails(value=true): { options+: { enableLogDetails: value } }, + '#withPrettifyLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPrettifyLogMessage(value=true): { options+: { prettifyLogMessage: value } }, + '#withShowCommonLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowCommonLabels(value=true): { options+: { showCommonLabels: value } }, + '#withShowLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLabels(value=true): { options+: { showLabels: value } }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { options+: { showTime: value } }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: ['Descending', 'Ascending'], name: 'value', type: ['string'] }], help: '' } }, + withSortOrder(value): { options+: { sortOrder: value } }, + '#withWrapLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWrapLogMessage(value=true): { options+: { wrapLogMessage: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'logs' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/news.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/news.libsonnet new file mode 100644 index 0000000..0b12f85 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/news.libsonnet @@ -0,0 +1,17 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.news', name: 'news' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withFeedUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'empty/missing will default to grafana blog' } }, + withFeedUrl(value): { options+: { feedUrl: value } }, + '#withShowImage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowImage(value=true): { options+: { showImage: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'news' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/nodeGraph.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/nodeGraph.libsonnet new file mode 100644 index 0000000..447b29c --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/nodeGraph.libsonnet @@ -0,0 +1,100 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.nodeGraph', name: 'nodeGraph' }, + '#withArcOption': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withArcOption(value): { ArcOption: value }, + '#withArcOptionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withArcOptionMixin(value): { ArcOption+: value }, + ArcOption+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The color of the arc.' } }, + withColor(value): { ArcOption+: { color: value } }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field from which to get the value. Values should be less than 1, representing fraction of a circle.' } }, + withField(value): { ArcOption+: { field: value } }, + }, + '#withEdgeOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdgeOptions(value): { EdgeOptions: value }, + '#withEdgeOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdgeOptionsMixin(value): { EdgeOptions+: value }, + EdgeOptions+: + { + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { EdgeOptions+: { mainStatUnit: value } }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { EdgeOptions+: { secondaryStatUnit: value } }, + }, + '#withNodeOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodeOptions(value): { NodeOptions: value }, + '#withNodeOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodeOptionsMixin(value): { NodeOptions+: value }, + NodeOptions+: + { + '#withArcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcs(value): { NodeOptions+: { arcs: (if std.isArray(value) + then value + else [value]) } }, + '#withArcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcsMixin(value): { NodeOptions+: { arcs+: (if std.isArray(value) + then value + else [value]) } }, + arcs+: + { + '#': { help: '', name: 'arcs' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The color of the arc.' } }, + withColor(value): { color: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field from which to get the value. Values should be less than 1, representing fraction of a circle.' } }, + withField(value): { field: value }, + }, + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { NodeOptions+: { mainStatUnit: value } }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { NodeOptions+: { secondaryStatUnit: value } }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdges(value): { options+: { edges: value } }, + '#withEdgesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdgesMixin(value): { options+: { edges+: value } }, + edges+: + { + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { options+: { edges+: { mainStatUnit: value } } }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { options+: { edges+: { secondaryStatUnit: value } } }, + }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { options+: { nodes: value } }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { options+: { nodes+: value } }, + nodes+: + { + '#withArcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcs(value): { options+: { nodes+: { arcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withArcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcsMixin(value): { options+: { nodes+: { arcs+: (if std.isArray(value) + then value + else [value]) } } }, + arcs+: + { + '#': { help: '', name: 'arcs' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The color of the arc.' } }, + withColor(value): { color: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field from which to get the value. Values should be less than 1, representing fraction of a circle.' } }, + withField(value): { field: value }, + }, + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { options+: { nodes+: { mainStatUnit: value } } }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { options+: { nodes+: { secondaryStatUnit: value } } }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'nodeGraph' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/pieChart.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/pieChart.libsonnet new file mode 100644 index 0000000..d34fe24 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/pieChart.libsonnet @@ -0,0 +1,186 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.pieChart', name: 'pieChart' }, + '#withPieChartLabels': { 'function': { args: [{ default: null, enums: ['name', 'value', 'percent'], name: 'value', type: ['string'] }], help: 'Select labels to display on the pie chart.\n - Name - The series or field name.\n - Percent - The percentage of the whole.\n - Value - The raw numerical value.' } }, + withPieChartLabels(value): { PieChartLabels: value }, + '#withPieChartLegendOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPieChartLegendOptions(value): { PieChartLegendOptions: value }, + '#withPieChartLegendOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPieChartLegendOptionsMixin(value): { PieChartLegendOptions+: value }, + PieChartLegendOptions+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { PieChartLegendOptions+: { asTable: value } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { PieChartLegendOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { PieChartLegendOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { PieChartLegendOptions+: { displayMode: value } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { PieChartLegendOptions+: { isVisible: value } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { PieChartLegendOptions+: { placement: value } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { PieChartLegendOptions+: { showLegend: value } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { PieChartLegendOptions+: { sortBy: value } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { PieChartLegendOptions+: { sortDesc: value } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { PieChartLegendOptions+: { width: value } }, + '#withValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValues(value): { PieChartLegendOptions+: { values: (if std.isArray(value) + then value + else [value]) } }, + '#withValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValuesMixin(value): { PieChartLegendOptions+: { values+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withPieChartLegendValues': { 'function': { args: [{ default: null, enums: ['value', 'percent'], name: 'value', type: ['string'] }], help: 'Select values to display in the legend.\n - Percent: The percentage of the whole.\n - Value: The raw numerical value.' } }, + withPieChartLegendValues(value): { PieChartLegendValues: value }, + '#withPieChartType': { 'function': { args: [{ default: null, enums: ['pie', 'donut'], name: 'value', type: ['string'] }], help: 'Select the pie chart display style.' } }, + withPieChartType(value): { PieChartType: value }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { options+: { reduceOptions: value } }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { options+: { reduceOptions+: value } }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { options+: { reduceOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { options+: { reduceOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { options+: { reduceOptions+: { fields: value } } }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { options+: { reduceOptions+: { limit: value } } }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { options+: { reduceOptions+: { values: value } } }, + }, + '#withDisplayLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabels(value): { options+: { displayLabels: (if std.isArray(value) + then value + else [value]) } }, + '#withDisplayLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabelsMixin(value): { options+: { displayLabels+: (if std.isArray(value) + then value + else [value]) } }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + '#withValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValues(value): { options+: { legend+: { values: (if std.isArray(value) + then value + else [value]) } } }, + '#withValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValuesMixin(value): { options+: { legend+: { values+: (if std.isArray(value) + then value + else [value]) } } }, + }, + '#withPieType': { 'function': { args: [{ default: null, enums: ['pie', 'donut'], name: 'value', type: ['string'] }], help: 'Select the pie chart display style.' } }, + withPieType(value): { options+: { pieType: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'piechart' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/row.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/row.libsonnet new file mode 100644 index 0000000..5c4a5b4 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/row.libsonnet @@ -0,0 +1,51 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.row', name: 'row' }, + '#withCollapsed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether this row should be collapsed or not.' } }, + withCollapsed(value=true): { collapsed: value }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { datasource: value }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { datasource+: value }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { type: value } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { datasource+: { uid: value } }, + }, + '#withGridPos': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPos(value): { gridPos: value }, + '#withGridPosMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPosMixin(value): { gridPos+: value }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { gridPos+: { h: value } }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { gridPos+: { static: value } }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { gridPos+: { w: value } }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { gridPos+: { x: value } }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { gridPos+: { y: value } }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally.' } }, + withId(value): { id: value }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { panels: (if std.isArray(value) + then value + else [value]) }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { panels+: (if std.isArray(value) + then value + else [value]) }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { repeat: value }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Row title' } }, + withTitle(value): { title: value }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'row' }, +} ++ (import '../../custom/row.libsonnet') diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/stat.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/stat.libsonnet new file mode 100644 index 0000000..9524c17 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/stat.libsonnet @@ -0,0 +1,55 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.stat', name: 'stat' }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { options+: { text: value } }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { options+: { text+: value } }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { options+: { text+: { titleSize: value } } }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { options+: { text+: { valueSize: value } } }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { options+: { orientation: value } }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { options+: { reduceOptions: value } }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { options+: { reduceOptions+: value } }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { options+: { reduceOptions+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { options+: { reduceOptions+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { options+: { reduceOptions+: { fields: value } } }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { options+: { reduceOptions+: { limit: value } } }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { options+: { reduceOptions+: { values: value } } }, + }, + '#withColorMode': { 'function': { args: [{ default: null, enums: ['value', 'background', 'background_solid', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withColorMode(value): { options+: { colorMode: value } }, + '#withGraphMode': { 'function': { args: [{ default: null, enums: ['none', 'line', 'area'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGraphMode(value): { options+: { graphMode: value } }, + '#withJustifyMode': { 'function': { args: [{ default: null, enums: ['auto', 'center'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withJustifyMode(value): { options+: { justifyMode: value } }, + '#withTextMode': { 'function': { args: [{ default: null, enums: ['auto', 'value', 'value_and_name', 'name', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTextMode(value): { options+: { textMode: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'stat' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/stateTimeline.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/stateTimeline.libsonnet new file mode 100644 index 0000000..8df62bd --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/stateTimeline.libsonnet @@ -0,0 +1,109 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.stateTimeline', name: 'stateTimeline' }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withLineWidth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=0): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { options+: { timezone: (if std.isArray(value) + then value + else [value]) } }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { options+: { timezone+: (if std.isArray(value) + then value + else [value]) } }, + '#withAlignValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls value alignment on the timelines' } }, + withAlignValue(value): { options+: { alignValue: value } }, + '#withMergeValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Merge equal consecutive values' } }, + withMergeValues(value=true): { options+: { mergeValues: value } }, + '#withRowHeight': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Controls the row height' } }, + withRowHeight(value=0.90000000000000002): { options+: { rowHeight: value } }, + '#withShowValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Show timeline values on chart' } }, + withShowValue(value): { options+: { showValue: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'state-timeline' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/statusHistory.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/statusHistory.libsonnet new file mode 100644 index 0000000..738e705 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/statusHistory.libsonnet @@ -0,0 +1,107 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.statusHistory', name: 'statusHistory' }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=1): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { options+: { timezone: (if std.isArray(value) + then value + else [value]) } }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { options+: { timezone+: (if std.isArray(value) + then value + else [value]) } }, + '#withColWidth': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Controls the column width' } }, + withColWidth(value=0.90000000000000002): { options+: { colWidth: value } }, + '#withRowHeight': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Set the height of the rows' } }, + withRowHeight(value=0.90000000000000002): { options+: { rowHeight: value } }, + '#withShowValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Show values on the columns' } }, + withShowValue(value): { options+: { showValue: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'status-history' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/table.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/table.libsonnet new file mode 100644 index 0000000..469ddb6 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/table.libsonnet @@ -0,0 +1,305 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.table', name: 'table' }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withAlign': { 'function': { args: [{ default: null, enums: ['auto', 'left', 'right', 'center'], name: 'value', type: ['string'] }], help: 'TODO -- should not be table specific!\nTODO docs' } }, + withAlign(value): { fieldConfig+: { defaults+: { custom+: { align: value } } } }, + '#withCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions: value } } } }, + '#withCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: value } } } }, + cellOptions+: + { + '#withTableAutoCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableAutoCellOptions: value } } } } }, + '#withTableAutoCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableAutoCellOptions+: value } } } } }, + TableAutoCellOptions+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableSparklineCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableSparklineCellOptions: value } } } } }, + '#withTableSparklineCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableSparklineCellOptions+: value } } } } }, + TableSparklineCellOptions+: + { + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineColor: value } } } } }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineInterpolation: value } } } } }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle: value } } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle+: value } } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineStyle+: { fill: value } } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { lineWidth: value } } } } }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { spanNulls: value } } } } }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { spanNulls+: value } } } } }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { fillBelowTo: value } } } } }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { fillColor: value } } } } }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { fillOpacity: value } } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { pointColor: value } } } } }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { pointSize: value } } } } }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { pointSymbol: value } } } } }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { showPoints: value } } } } }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisBorderShow: value } } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisCenteredZero: value } } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisColorMode: value } } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisGridShow: value } } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisLabel: value } } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisPlacement: value } } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisSoftMax: value } } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisSoftMin: value } } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { axisWidth: value } } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution: value } } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution+: value } } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution+: { linearThreshold: value } } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution+: { log: value } } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { scaleDistribution+: { type: value } } } } } }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['integer'] }], help: 'TODO docs' } }, + withBarAlignment(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { barAlignment: value } } } } }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { barMaxWidth: value } } } } }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { barWidthFactor: value } } } } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { stacking: value } } } } }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { stacking+: value } } } } }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { stacking+: { group: value } } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { stacking+: { mode: value } } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom: value } } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom+: value } } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom+: { legend: value } } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom+: { tooltip: value } } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideFrom+: { viz: value } } } } } }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { drawStyle: value } } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { gradientMode: value } } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { thresholdsStyle: value } } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { thresholdsStyle+: value } } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { thresholdsStyle+: { mode: value } } } } } }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { transform: value } } } } }, + '#withHideValue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHideValue(value=true): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { hideValue: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableBarGaugeCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableBarGaugeCellOptions: value } } } } }, + '#withTableBarGaugeCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableBarGaugeCellOptions+: value } } } } }, + TableBarGaugeCellOptions+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { mode: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + '#withValueDisplayMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueDisplayMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { valueDisplayMode: value } } } } }, + }, + '#withTableColoredBackgroundCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableColoredBackgroundCellOptions: value } } } } }, + '#withTableColoredBackgroundCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableColoredBackgroundCellOptions+: value } } } } }, + TableColoredBackgroundCellOptions+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'gradient'], name: 'value', type: ['string'] }], help: 'Display mode to the "Colored Background" display\nmode for table cells. Either displays a solid color (basic mode)\nor a gradient.' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { mode: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableColorTextCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableColorTextCellOptions: value } } } } }, + '#withTableColorTextCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableColorTextCellOptions+: value } } } } }, + TableColorTextCellOptions+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableImageCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableImageCellOptions: value } } } } }, + '#withTableImageCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableImageCellOptions+: value } } } } }, + TableImageCellOptions+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + '#withTableJsonViewCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptions(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableJsonViewCellOptions: value } } } } }, + '#withTableJsonViewCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptionsMixin(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { TableJsonViewCellOptions+: value } } } } }, + TableJsonViewCellOptions+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { cellOptions+: { type: value } } } } }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['auto', 'color-text', 'color-background', 'color-background-solid', 'gradient-gauge', 'lcd-gauge', 'json-view', 'basic', 'image', 'gauge', 'sparkline', 'custom'], name: 'value', type: ['string'] }], help: "Internally, this is the \"type\" of cell that's being displayed\nin the table such as colored text, JSON, gauge, etc.\nThe color-background-solid, gradient-gauge, and lcd-gauge\nmodes are deprecated in favor of new cell subOptions" } }, + withDisplayMode(value): { fieldConfig+: { defaults+: { custom+: { displayMode: value } } } }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFilterable(value=true): { fieldConfig+: { defaults+: { custom+: { filterable: value } } } }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHidden(value=true): { fieldConfig+: { defaults+: { custom+: { hidden: value } } } }, + '#withHideHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Hides any header for a column, useful for columns that show some static content or buttons.' } }, + withHideHeader(value=true): { fieldConfig+: { defaults+: { custom+: { hideHeader: value } } } }, + '#withInspect': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInspect(value=true): { fieldConfig+: { defaults+: { custom+: { inspect: value } } } }, + '#withMinWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMinWidth(value): { fieldConfig+: { defaults+: { custom+: { minWidth: value } } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { fieldConfig+: { defaults+: { custom+: { width: value } } } }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withCellHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the height of the rows' } }, + withCellHeight(value): { options+: { cellHeight: value } }, + '#withFooter': { 'function': { args: [{ default: { countRows: false, reducer: [], show: false }, enums: null, name: 'value', type: ['object'] }], help: 'Controls footer options' } }, + withFooter(value={ countRows: false, reducer: [], show: false }): { options+: { footer: value } }, + '#withFooterMixin': { 'function': { args: [{ default: { countRows: false, reducer: [], show: false }, enums: null, name: 'value', type: ['object'] }], help: 'Controls footer options' } }, + withFooterMixin(value): { options+: { footer+: value } }, + footer+: + { + '#withTableFooterOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withTableFooterOptions(value): { options+: { footer+: { TableFooterOptions: value } } }, + '#withTableFooterOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withTableFooterOptionsMixin(value): { options+: { footer+: { TableFooterOptions+: value } } }, + TableFooterOptions+: + { + '#withCountRows': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withCountRows(value=true): { options+: { footer+: { countRows: value } } }, + '#withEnablePagination': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnablePagination(value=true): { options+: { footer+: { enablePagination: value } } }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { options+: { footer+: { fields: (if std.isArray(value) + then value + else [value]) } } }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { options+: { footer+: { fields+: (if std.isArray(value) + then value + else [value]) } } }, + '#withReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withReducer(value): { options+: { footer+: { reducer: (if std.isArray(value) + then value + else [value]) } } }, + '#withReducerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withReducerMixin(value): { options+: { footer+: { reducer+: (if std.isArray(value) + then value + else [value]) } } }, + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShow(value=true): { options+: { footer+: { show: value } } }, + }, + }, + '#withFrameIndex': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Represents the index of the selected frame' } }, + withFrameIndex(value=0): { options+: { frameIndex: value } }, + '#withShowHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the panel should show the header' } }, + withShowHeader(value=true): { options+: { showHeader: value } }, + '#withShowTypeIcons': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the header should show icons for the column types' } }, + withShowTypeIcons(value=true): { options+: { showTypeIcons: value } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortBy(value): { options+: { sortBy: (if std.isArray(value) + then value + else [value]) } }, + '#withSortByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortByMixin(value): { options+: { sortBy+: (if std.isArray(value) + then value + else [value]) } }, + sortBy+: + { + '#': { help: '', name: 'sortBy' }, + '#withDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag used to indicate descending sort order' } }, + withDesc(value=true): { desc: value }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the display name of the field to sort by' } }, + withDisplayName(value): { displayName: value }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'table' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/text.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/text.libsonnet new file mode 100644 index 0000000..1054c03 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/text.libsonnet @@ -0,0 +1,47 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.text', name: 'text' }, + '#withCodeLanguage': { 'function': { args: [{ default: 'plaintext', enums: ['plaintext', 'yaml', 'xml', 'typescript', 'sql', 'go', 'markdown', 'html', 'json'], name: 'value', type: ['string'] }], help: '' } }, + withCodeLanguage(value='plaintext'): { CodeLanguage: value }, + '#withCodeOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCodeOptions(value): { CodeOptions: value }, + '#withCodeOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCodeOptionsMixin(value): { CodeOptions+: value }, + CodeOptions+: + { + '#withLanguage': { 'function': { args: [{ default: 'plaintext', enums: ['plaintext', 'yaml', 'xml', 'typescript', 'sql', 'go', 'markdown', 'html', 'json'], name: 'value', type: ['string'] }], help: '' } }, + withLanguage(value='plaintext'): { CodeOptions+: { language: value } }, + '#withShowLineNumbers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLineNumbers(value=true): { CodeOptions+: { showLineNumbers: value } }, + '#withShowMiniMap': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowMiniMap(value=true): { CodeOptions+: { showMiniMap: value } }, + }, + '#withTextMode': { 'function': { args: [{ default: null, enums: ['html', 'markdown', 'code'], name: 'value', type: ['string'] }], help: '' } }, + withTextMode(value): { TextMode: value }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withCode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCode(value): { options+: { code: value } }, + '#withCodeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCodeMixin(value): { options+: { code+: value } }, + code+: + { + '#withLanguage': { 'function': { args: [{ default: 'plaintext', enums: ['plaintext', 'yaml', 'xml', 'typescript', 'sql', 'go', 'markdown', 'html', 'json'], name: 'value', type: ['string'] }], help: '' } }, + withLanguage(value='plaintext'): { options+: { code+: { language: value } } }, + '#withShowLineNumbers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLineNumbers(value=true): { options+: { code+: { showLineNumbers: value } } }, + '#withShowMiniMap': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowMiniMap(value=true): { options+: { code+: { showMiniMap: value } } }, + }, + '#withContent': { 'function': { args: [{ default: '# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withContent(value='# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)'): { options+: { content: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['html', 'markdown', 'code'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { options+: { mode: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'text' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/timeSeries.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/timeSeries.libsonnet new file mode 100644 index 0000000..65f7845 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/timeSeries.libsonnet @@ -0,0 +1,201 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.timeSeries', name: 'timeSeries' }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { lineColor: value } } } }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { fieldConfig+: { defaults+: { custom+: { lineInterpolation: value } } } }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { lineStyle: value } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: value } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { fill: value } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { fieldConfig+: { defaults+: { custom+: { spanNulls: value } } } }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { fieldConfig+: { defaults+: { custom+: { spanNulls+: value } } } }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { fieldConfig+: { defaults+: { custom+: { fillBelowTo: value } } } }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { fieldConfig+: { defaults+: { custom+: { fillColor: value } } } }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { pointColor: value } } } }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { pointSize: value } } } }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { fieldConfig+: { defaults+: { custom+: { pointSymbol: value } } } }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { fieldConfig+: { defaults+: { custom+: { showPoints: value } } } }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['integer'] }], help: 'TODO docs' } }, + withBarAlignment(value): { fieldConfig+: { defaults+: { custom+: { barAlignment: value } } } }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { fieldConfig+: { defaults+: { custom+: { barMaxWidth: value } } } }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { fieldConfig+: { defaults+: { custom+: { barWidthFactor: value } } } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { fieldConfig+: { defaults+: { custom+: { stacking: value } } } }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { fieldConfig+: { defaults+: { custom+: { stacking+: value } } } }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { group: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { mode: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { fieldConfig+: { defaults+: { custom+: { drawStyle: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle: value } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: value } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: { mode: value } } } } }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { fieldConfig+: { defaults+: { custom+: { transform: value } } } }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { options+: { timezone: (if std.isArray(value) + then value + else [value]) } }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { options+: { timezone+: (if std.isArray(value) + then value + else [value]) } }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'timeseries' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/trend.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/trend.libsonnet new file mode 100644 index 0000000..54ad745 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/trend.libsonnet @@ -0,0 +1,195 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.trend', name: 'trend' }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { lineColor: value } } } }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { fieldConfig+: { defaults+: { custom+: { lineInterpolation: value } } } }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { lineStyle: value } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: value } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { fill: value } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { fieldConfig+: { defaults+: { custom+: { spanNulls: value } } } }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { fieldConfig+: { defaults+: { custom+: { spanNulls+: value } } } }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { fieldConfig+: { defaults+: { custom+: { fillBelowTo: value } } } }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { fieldConfig+: { defaults+: { custom+: { fillColor: value } } } }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { fieldConfig+: { defaults+: { custom+: { fillOpacity: value } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { pointColor: value } } } }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { pointSize: value } } } }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { fieldConfig+: { defaults+: { custom+: { pointSymbol: value } } } }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { fieldConfig+: { defaults+: { custom+: { showPoints: value } } } }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['integer'] }], help: 'TODO docs' } }, + withBarAlignment(value): { fieldConfig+: { defaults+: { custom+: { barAlignment: value } } } }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { fieldConfig+: { defaults+: { custom+: { barMaxWidth: value } } } }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { fieldConfig+: { defaults+: { custom+: { barWidthFactor: value } } } }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { fieldConfig+: { defaults+: { custom+: { stacking: value } } } }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { fieldConfig+: { defaults+: { custom+: { stacking+: value } } } }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { group: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { stacking+: { mode: value } } } } }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { fieldConfig+: { defaults+: { custom+: { drawStyle: value } } } }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { fieldConfig+: { defaults+: { custom+: { gradientMode: value } } } }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle: value } } } }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: value } } } }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { thresholdsStyle+: { mode: value } } } } }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { fieldConfig+: { defaults+: { custom+: { transform: value } } } }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Identical to timeseries... except it does not have timezone settings' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Identical to timeseries... except it does not have timezone settings' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the x field to use (defaults to first number)' } }, + withXField(value): { options+: { xField: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'trend' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/xyChart.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/xyChart.libsonnet new file mode 100644 index 0000000..f516237 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/panel/xyChart.libsonnet @@ -0,0 +1,508 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.xyChart', name: 'xyChart' }, + '#withScatterSeriesConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withScatterSeriesConfig(value): { ScatterSeriesConfig: value }, + '#withScatterSeriesConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withScatterSeriesConfigMixin(value): { ScatterSeriesConfig+: value }, + ScatterSeriesConfig+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { ScatterSeriesConfig+: { hideFrom: value } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { ScatterSeriesConfig+: { hideFrom+: value } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { ScatterSeriesConfig+: { hideFrom+: { legend: value } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { ScatterSeriesConfig+: { hideFrom+: { tooltip: value } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { ScatterSeriesConfig+: { hideFrom+: { viz: value } } }, + }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { ScatterSeriesConfig+: { axisBorderShow: value } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { ScatterSeriesConfig+: { axisCenteredZero: value } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { ScatterSeriesConfig+: { axisColorMode: value } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { ScatterSeriesConfig+: { axisGridShow: value } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { ScatterSeriesConfig+: { axisLabel: value } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { ScatterSeriesConfig+: { axisPlacement: value } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { ScatterSeriesConfig+: { axisSoftMax: value } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { ScatterSeriesConfig+: { axisSoftMin: value } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { ScatterSeriesConfig+: { axisWidth: value } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { ScatterSeriesConfig+: { scaleDistribution: value } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { ScatterSeriesConfig+: { scaleDistribution+: value } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { ScatterSeriesConfig+: { scaleDistribution+: { linearThreshold: value } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { ScatterSeriesConfig+: { scaleDistribution+: { log: value } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { ScatterSeriesConfig+: { scaleDistribution+: { type: value } } }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { ScatterSeriesConfig+: { label: value } }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { ScatterSeriesConfig+: { labelValue: value } }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { ScatterSeriesConfig+: { labelValue+: value } }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { ScatterSeriesConfig+: { labelValue+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { ScatterSeriesConfig+: { labelValue+: { fixed: value } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { ScatterSeriesConfig+: { labelValue+: { mode: value } } }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { ScatterSeriesConfig+: { lineColor: value } }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { ScatterSeriesConfig+: { lineColor+: value } }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { ScatterSeriesConfig+: { lineColor+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { ScatterSeriesConfig+: { lineColor+: { fixed: value } } }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { ScatterSeriesConfig+: { lineStyle: value } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { ScatterSeriesConfig+: { lineStyle+: value } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { ScatterSeriesConfig+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { ScatterSeriesConfig+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { ScatterSeriesConfig+: { lineStyle+: { fill: value } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { ScatterSeriesConfig+: { lineWidth: value } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { ScatterSeriesConfig+: { pointColor: value } }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { ScatterSeriesConfig+: { pointColor+: value } }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { ScatterSeriesConfig+: { pointColor+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { ScatterSeriesConfig+: { pointColor+: { fixed: value } } }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { ScatterSeriesConfig+: { pointSize: value } }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { ScatterSeriesConfig+: { pointSize+: value } }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { ScatterSeriesConfig+: { pointSize+: { field: value } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { ScatterSeriesConfig+: { pointSize+: { fixed: value } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { ScatterSeriesConfig+: { pointSize+: { max: value } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { ScatterSeriesConfig+: { pointSize+: { min: value } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { ScatterSeriesConfig+: { pointSize+: { mode: value } } }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { ScatterSeriesConfig+: { show: value } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { ScatterSeriesConfig+: { name: value } }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { ScatterSeriesConfig+: { x: value } }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withY(value): { ScatterSeriesConfig+: { y: value } }, + }, + '#withScatterShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withScatterShow(value): { ScatterShow: value }, + '#withSeriesMapping': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: '' } }, + withSeriesMapping(value): { SeriesMapping: value }, + '#withXYDimensionConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXYDimensionConfig(value): { XYDimensionConfig: value }, + '#withXYDimensionConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXYDimensionConfigMixin(value): { XYDimensionConfig+: value }, + XYDimensionConfig+: + { + '#withExclude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExclude(value): { XYDimensionConfig+: { exclude: (if std.isArray(value) + then value + else [value]) } }, + '#withExcludeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExcludeMixin(value): { XYDimensionConfig+: { exclude+: (if std.isArray(value) + then value + else [value]) } }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFrame(value): { XYDimensionConfig+: { frame: value } }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { XYDimensionConfig+: { x: value } }, + }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfig(value): { fieldConfig: value }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldConfigMixin(value): { fieldConfig+: value }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaults(value): { fieldConfig+: { defaults: value } }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDefaultsMixin(value): { fieldConfig+: { defaults+: value } }, + defaults+: + { + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustom(value): { fieldConfig+: { defaults+: { custom: value } } }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomMixin(value): { fieldConfig+: { defaults+: { custom+: value } } }, + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { fieldConfig+: { defaults+: { custom+: { hideFrom: value } } } }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { fieldConfig+: { defaults+: { custom+: { hideFrom+: value } } } }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { legend: value } } } } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { tooltip: value } } } } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { fieldConfig+: { defaults+: { custom+: { hideFrom+: { viz: value } } } } }, + }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisBorderShow: value } } } }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { fieldConfig+: { defaults+: { custom+: { axisCenteredZero: value } } } }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { fieldConfig+: { defaults+: { custom+: { axisColorMode: value } } } }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { fieldConfig+: { defaults+: { custom+: { axisGridShow: value } } } }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { fieldConfig+: { defaults+: { custom+: { axisLabel: value } } } }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { fieldConfig+: { defaults+: { custom+: { axisPlacement: value } } } }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMax: value } } } }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { fieldConfig+: { defaults+: { custom+: { axisSoftMin: value } } } }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { fieldConfig+: { defaults+: { custom+: { axisWidth: value } } } }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution: value } } } }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: value } } } }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { linearThreshold: value } } } } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { log: value } } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { fieldConfig+: { defaults+: { custom+: { scaleDistribution+: { type: value } } } } }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { fieldConfig+: { defaults+: { custom+: { label: value } } } }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { fieldConfig+: { defaults+: { custom+: { labelValue: value } } } }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { fieldConfig+: { defaults+: { custom+: { labelValue+: value } } } }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { fieldConfig+: { defaults+: { custom+: { labelValue+: { field: value } } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { fieldConfig+: { defaults+: { custom+: { labelValue+: { fixed: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { labelValue+: { mode: value } } } } }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { fieldConfig+: { defaults+: { custom+: { lineColor: value } } } }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { fieldConfig+: { defaults+: { custom+: { lineColor+: value } } } }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { fieldConfig+: { defaults+: { custom+: { lineColor+: { field: value } } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { fieldConfig+: { defaults+: { custom+: { lineColor+: { fixed: value } } } } }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { fieldConfig+: { defaults+: { custom+: { lineStyle: value } } } }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: value } } } }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } } } } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { fieldConfig+: { defaults+: { custom+: { lineStyle+: { fill: value } } } } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { fieldConfig+: { defaults+: { custom+: { lineWidth: value } } } }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { fieldConfig+: { defaults+: { custom+: { pointColor: value } } } }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { fieldConfig+: { defaults+: { custom+: { pointColor+: value } } } }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { fieldConfig+: { defaults+: { custom+: { pointColor+: { field: value } } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { fieldConfig+: { defaults+: { custom+: { pointColor+: { fixed: value } } } } }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { fieldConfig+: { defaults+: { custom+: { pointSize: value } } } }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: value } } } }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { field: value } } } } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { fixed: value } } } } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { max: value } } } } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { min: value } } } } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { fieldConfig+: { defaults+: { custom+: { pointSize+: { mode: value } } } } }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { fieldConfig+: { defaults+: { custom+: { show: value } } } }, + }, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { options: value }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { options+: value }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { options+: { legend: value } }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { options+: { legend+: value } }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { options+: { legend+: { asTable: value } } }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { options+: { legend+: { calcs: (if std.isArray(value) + then value + else [value]) } } }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { options+: { legend+: { calcs+: (if std.isArray(value) + then value + else [value]) } } }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { options+: { legend+: { displayMode: value } } }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { options+: { legend+: { isVisible: value } } }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { options+: { legend+: { placement: value } } }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { options+: { legend+: { showLegend: value } } }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { options+: { legend+: { sortBy: value } } }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { options+: { legend+: { sortDesc: value } } }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { options+: { legend+: { width: value } } }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { options+: { tooltip: value } }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { options+: { tooltip+: value } }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { options+: { tooltip+: { mode: value } } }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { options+: { tooltip+: { sort: value } } }, + }, + '#withDims': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDims(value): { options+: { dims: value } }, + '#withDimsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDimsMixin(value): { options+: { dims+: value } }, + dims+: + { + '#withExclude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExclude(value): { options+: { dims+: { exclude: (if std.isArray(value) + then value + else [value]) } } }, + '#withExcludeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExcludeMixin(value): { options+: { dims+: { exclude+: (if std.isArray(value) + then value + else [value]) } } }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFrame(value): { options+: { dims+: { frame: value } } }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { options+: { dims+: { x: value } } }, + }, + '#withSeries': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withSeries(value): { options+: { series: (if std.isArray(value) + then value + else [value]) } }, + '#withSeriesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withSeriesMixin(value): { options+: { series+: (if std.isArray(value) + then value + else [value]) } }, + series+: + { + '#': { help: '', name: 'series' }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { hideFrom: value }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { hideFrom+: value }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { hideFrom+: { legend: value } }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { hideFrom+: { tooltip: value } }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { hideFrom+: { viz: value } }, + }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { axisBorderShow: value }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { axisCenteredZero: value }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { axisColorMode: value }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { axisGridShow: value }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { axisLabel: value }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { axisPlacement: value }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { axisSoftMax: value }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { axisSoftMin: value }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { axisWidth: value }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { scaleDistribution: value }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { scaleDistribution+: value }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { scaleDistribution+: { linearThreshold: value } }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { scaleDistribution+: { log: value } }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { scaleDistribution+: { type: value } }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { label: value }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { labelValue: value }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { labelValue+: value }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { labelValue+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { labelValue+: { fixed: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { labelValue+: { mode: value } }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { lineColor: value }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { lineColor+: value }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { lineColor+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { lineColor+: { fixed: value } }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { lineStyle: value }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { lineStyle+: value }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { lineStyle+: { dash: (if std.isArray(value) + then value + else [value]) } }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { lineStyle+: { dash+: (if std.isArray(value) + then value + else [value]) } }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { lineStyle+: { fill: value } }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { lineWidth: value }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { pointColor: value }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { pointColor+: value }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { pointColor+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { pointColor+: { fixed: value } }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { pointSize: value }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { pointSize+: value }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { pointSize+: { field: value } }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { pointSize+: { fixed: value } }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { pointSize+: { max: value } }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { pointSize+: { min: value } }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { pointSize+: { mode: value } }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { show: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { x: value }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withY(value): { y: value }, + }, + '#withSeriesMapping': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: '' } }, + withSeriesMapping(value): { options+: { seriesMapping: value } }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { type: 'xychart' }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/preferences.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/preferences.libsonnet new file mode 100644 index 0000000..9289dea --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/preferences.libsonnet @@ -0,0 +1,42 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.preferences', name: 'preferences' }, + '#withCookiePreferences': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCookiePreferences(value): { cookiePreferences: value }, + '#withCookiePreferencesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCookiePreferencesMixin(value): { cookiePreferences+: value }, + cookiePreferences+: + { + '#withAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnalytics(value): { cookiePreferences+: { analytics: value } }, + '#withAnalyticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnalyticsMixin(value): { cookiePreferences+: { analytics+: value } }, + '#withFunctional': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFunctional(value): { cookiePreferences+: { functional: value } }, + '#withFunctionalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFunctionalMixin(value): { cookiePreferences+: { functional+: value } }, + '#withPerformance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPerformance(value): { cookiePreferences+: { performance: value } }, + '#withPerformanceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPerformanceMixin(value): { cookiePreferences+: { performance+: value } }, + }, + '#withHomeDashboardUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID for the home dashboard' } }, + withHomeDashboardUID(value): { homeDashboardUID: value }, + '#withLanguage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Selected language (beta)' } }, + withLanguage(value): { language: value }, + '#withQueryHistory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryHistory(value): { queryHistory: value }, + '#withQueryHistoryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryHistoryMixin(value): { queryHistory+: value }, + queryHistory+: + { + '#withHomeTab': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "one of: '' | 'query' | 'starred';" } }, + withHomeTab(value): { queryHistory+: { homeTab: value } }, + }, + '#withTheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'light, dark, empty is default' } }, + withTheme(value): { theme: value }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The timezone selection\nTODO: this should use the timezone defined in common' } }, + withTimezone(value): { timezone: value }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'day of the week (sunday, monday, etc)' } }, + withWeekStart(value): { weekStart: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/publicdashboard.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/publicdashboard.libsonnet new file mode 100644 index 0000000..3aefb7d --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/publicdashboard.libsonnet @@ -0,0 +1,16 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.publicdashboard', name: 'publicdashboard' }, + '#withAccessToken': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public access token' } }, + withAccessToken(value): { accessToken: value }, + '#withAnnotationsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if annotations are enabled' } }, + withAnnotationsEnabled(value=true): { annotationsEnabled: value }, + '#withDashboardUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Dashboard unique identifier referenced by this public dashboard' } }, + withDashboardUid(value): { dashboardUid: value }, + '#withIsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the public dashboard is enabled' } }, + withIsEnabled(value=true): { isEnabled: value }, + '#withTimeSelectionEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the time range picker is enabled' } }, + withTimeSelectionEnabled(value=true): { timeSelectionEnabled: value }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public dashboard identifier' } }, + withUid(value): { uid: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/azureMonitor.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/azureMonitor.libsonnet new file mode 100644 index 0000000..1f03762 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/azureMonitor.libsonnet @@ -0,0 +1,369 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.azureMonitor', name: 'azureMonitor' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withAzureLogAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, + withAzureLogAnalytics(value): { azureLogAnalytics: value }, + '#withAzureLogAnalyticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, + withAzureLogAnalyticsMixin(value): { azureLogAnalytics+: value }, + azureLogAnalytics+: + { + '#withDashboardTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false.' } }, + withDashboardTime(value=true): { azureLogAnalytics+: { dashboardTime: value } }, + '#withIntersectTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated Use dashboardTime instead' } }, + withIntersectTime(value=true): { azureLogAnalytics+: { intersectTime: value } }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'KQL query to be executed.' } }, + withQuery(value): { azureLogAnalytics+: { query: value } }, + '#withResource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResource(value): { azureLogAnalytics+: { resource: value } }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { azureLogAnalytics+: { resources: (if std.isArray(value) + then value + else [value]) } }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { azureLogAnalytics+: { resources+: (if std.isArray(value) + then value + else [value]) } }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: ['table', 'time_series', 'trace'], name: 'value', type: ['string'] }], help: '' } }, + withResultFormat(value): { azureLogAnalytics+: { resultFormat: value } }, + '#withTimeColumn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated' } }, + withTimeColumn(value): { azureLogAnalytics+: { timeColumn: value } }, + '#withWorkspace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Workspace ID. This was removed in Grafana 8, but remains for backwards compat.' } }, + withWorkspace(value): { azureLogAnalytics+: { workspace: value } }, + }, + '#withAzureMonitor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureMonitor(value): { azureMonitor: value }, + '#withAzureMonitorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureMonitorMixin(value): { azureMonitor+: value }, + azureMonitor+: + { + '#withAggregation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric.' } }, + withAggregation(value): { azureMonitor+: { aggregation: value } }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail.' } }, + withAlias(value): { azureMonitor+: { alias: value } }, + '#withAllowedTimeGrainsMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Time grains that are supported by the metric.' } }, + withAllowedTimeGrainsMs(value): { azureMonitor+: { allowedTimeGrainsMs: (if std.isArray(value) + then value + else [value]) } }, + '#withAllowedTimeGrainsMsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Time grains that are supported by the metric.' } }, + withAllowedTimeGrainsMsMixin(value): { azureMonitor+: { allowedTimeGrainsMs+: (if std.isArray(value) + then value + else [value]) } }, + '#withCustomNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Used as the value for the metricNamespace property when it's different from the resource namespace." } }, + withCustomNamespace(value): { azureMonitor+: { customNamespace: value } }, + '#withDimension': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration' } }, + withDimension(value): { azureMonitor+: { dimension: value } }, + '#withDimensionFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration' } }, + withDimensionFilter(value): { azureMonitor+: { dimensionFilter: value } }, + '#withDimensionFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.' } }, + withDimensionFilters(value): { azureMonitor+: { dimensionFilters: (if std.isArray(value) + then value + else [value]) } }, + '#withDimensionFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.' } }, + withDimensionFiltersMixin(value): { azureMonitor+: { dimensionFilters+: (if std.isArray(value) + then value + else [value]) } }, + dimensionFilters+: + { + '#': { help: '', name: 'dimensionFilters' }, + '#withDimension': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of Dimension to be filtered on.' } }, + withDimension(value): { dimension: value }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated filter is deprecated in favour of filters to support multiselect.' } }, + withFilter(value): { filter: value }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to match with the filter.' } }, + withFilters(value): { filters: (if std.isArray(value) + then value + else [value]) }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to match with the filter.' } }, + withFiltersMixin(value): { filters+: (if std.isArray(value) + then value + else [value]) }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators." } }, + withOperator(value): { operator: value }, + }, + '#withMetricDefinition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use metricNamespace instead' } }, + withMetricDefinition(value): { azureMonitor+: { metricDefinition: value } }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The metric to query data for within the specified metricNamespace. e.g. UsedCapacity' } }, + withMetricName(value): { azureMonitor+: { metricName: value } }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "metricNamespace is used as the resource type (or resource namespace).\nIt's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts\nKept the name of the variable as metricNamespace to avoid backward incompatibility issues." } }, + withMetricNamespace(value): { azureMonitor+: { metricNamespace: value } }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The Azure region containing the resource(s).' } }, + withRegion(value): { azureMonitor+: { region: value } }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResourceGroup(value): { azureMonitor+: { resourceGroup: value } }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResourceName(value): { azureMonitor+: { resourceName: value } }, + '#withResourceUri': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resourceGroup, resourceName and metricNamespace instead' } }, + withResourceUri(value): { azureMonitor+: { resourceUri: value } }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { azureMonitor+: { resources: (if std.isArray(value) + then value + else [value]) } }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { azureMonitor+: { resources+: (if std.isArray(value) + then value + else [value]) } }, + resources+: + { + '#': { help: '', name: 'resources' }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { metricNamespace: value }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRegion(value): { region: value }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { resourceGroup: value }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { resourceName: value }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { subscription: value }, + }, + '#withTimeGrain': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The granularity of data points to be queried. Defaults to auto.' } }, + withTimeGrain(value): { azureMonitor+: { timeGrain: value } }, + '#withTimeGrainUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated' } }, + withTimeGrainUnit(value): { azureMonitor+: { timeGrainUnit: value } }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Maximum number of records to return. Defaults to 10.' } }, + withTop(value): { azureMonitor+: { top: value } }, + }, + '#withAzureResourceGraph': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureResourceGraph(value): { azureResourceGraph: value }, + '#withAzureResourceGraphMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureResourceGraphMixin(value): { azureResourceGraph+: value }, + azureResourceGraph+: + { + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure Resource Graph KQL query to be executed.' } }, + withQuery(value): { azureResourceGraph+: { query: value } }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the format results should be returned as. Defaults to table.' } }, + withResultFormat(value): { azureResourceGraph+: { resultFormat: value } }, + }, + '#withAzureTraces': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Application Insights Traces sub-query properties' } }, + withAzureTraces(value): { azureTraces: value }, + '#withAzureTracesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Application Insights Traces sub-query properties' } }, + withAzureTracesMixin(value): { azureTraces+: value }, + azureTraces+: + { + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters for property values.' } }, + withFilters(value): { azureTraces+: { filters: (if std.isArray(value) + then value + else [value]) } }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters for property values.' } }, + withFiltersMixin(value): { azureTraces+: { filters+: (if std.isArray(value) + then value + else [value]) } }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to filter by.' } }, + withFilters(value): { filters: (if std.isArray(value) + then value + else [value]) }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to filter by.' } }, + withFiltersMixin(value): { filters+: (if std.isArray(value) + then value + else [value]) }, + '#withOperation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Comparison operator to use. Either equals or not equals.' } }, + withOperation(value): { operation: value }, + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Property name, auto-populated based on available traces.' } }, + withProperty(value): { property: value }, + }, + '#withOperationId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Operation ID. Used only for Traces queries.' } }, + withOperationId(value): { azureTraces+: { operationId: value } }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'KQL query to be executed.' } }, + withQuery(value): { azureTraces+: { query: value } }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { azureTraces+: { resources: (if std.isArray(value) + then value + else [value]) } }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { azureTraces+: { resources+: (if std.isArray(value) + then value + else [value]) } }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: ['table', 'time_series', 'trace'], name: 'value', type: ['string'] }], help: '' } }, + withResultFormat(value): { azureTraces+: { resultFormat: value } }, + '#withTraceTypes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Types of events to filter by.' } }, + withTraceTypes(value): { azureTraces+: { traceTypes: (if std.isArray(value) + then value + else [value]) } }, + '#withTraceTypesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Types of events to filter by.' } }, + withTraceTypesMixin(value): { azureTraces+: { traceTypes+: (if std.isArray(value) + then value + else [value]) } }, + }, + '#withGrafanaTemplateVariableFn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withGrafanaTemplateVariableFn(value): { grafanaTemplateVariableFn: value }, + '#withGrafanaTemplateVariableFnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withGrafanaTemplateVariableFnMixin(value): { grafanaTemplateVariableFn+: value }, + grafanaTemplateVariableFn+: + { + '#withAppInsightsMetricNameQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsMetricNameQuery(value): { grafanaTemplateVariableFn+: { AppInsightsMetricNameQuery: value } }, + '#withAppInsightsMetricNameQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsMetricNameQueryMixin(value): { grafanaTemplateVariableFn+: { AppInsightsMetricNameQuery+: value } }, + AppInsightsMetricNameQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['AppInsightsMetricNameQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + }, + '#withAppInsightsGroupByQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsGroupByQuery(value): { grafanaTemplateVariableFn+: { AppInsightsGroupByQuery: value } }, + '#withAppInsightsGroupByQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsGroupByQueryMixin(value): { grafanaTemplateVariableFn+: { AppInsightsGroupByQuery+: value } }, + AppInsightsGroupByQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['AppInsightsGroupByQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricName(value): { grafanaTemplateVariableFn+: { metricName: value } }, + }, + '#withSubscriptionsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubscriptionsQuery(value): { grafanaTemplateVariableFn+: { SubscriptionsQuery: value } }, + '#withSubscriptionsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubscriptionsQueryMixin(value): { grafanaTemplateVariableFn+: { SubscriptionsQuery+: value } }, + SubscriptionsQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['SubscriptionsQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + }, + '#withResourceGroupsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceGroupsQuery(value): { grafanaTemplateVariableFn+: { ResourceGroupsQuery: value } }, + '#withResourceGroupsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceGroupsQueryMixin(value): { grafanaTemplateVariableFn+: { ResourceGroupsQuery+: value } }, + ResourceGroupsQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['ResourceGroupsQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { grafanaTemplateVariableFn+: { subscription: value } }, + }, + '#withResourceNamesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceNamesQuery(value): { grafanaTemplateVariableFn+: { ResourceNamesQuery: value } }, + '#withResourceNamesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceNamesQueryMixin(value): { grafanaTemplateVariableFn+: { ResourceNamesQuery+: value } }, + ResourceNamesQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['ResourceNamesQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { grafanaTemplateVariableFn+: { metricNamespace: value } }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { grafanaTemplateVariableFn+: { resourceGroup: value } }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { grafanaTemplateVariableFn+: { subscription: value } }, + }, + '#withMetricNamespaceQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamespaceQuery(value): { grafanaTemplateVariableFn+: { MetricNamespaceQuery: value } }, + '#withMetricNamespaceQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamespaceQueryMixin(value): { grafanaTemplateVariableFn+: { MetricNamespaceQuery+: value } }, + MetricNamespaceQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['MetricNamespaceQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { grafanaTemplateVariableFn+: { metricNamespace: value } }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { grafanaTemplateVariableFn+: { resourceGroup: value } }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { grafanaTemplateVariableFn+: { resourceName: value } }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { grafanaTemplateVariableFn+: { subscription: value } }, + }, + '#withMetricDefinitionsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '@deprecated Use MetricNamespaceQuery instead' } }, + withMetricDefinitionsQuery(value): { grafanaTemplateVariableFn+: { MetricDefinitionsQuery: value } }, + '#withMetricDefinitionsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '@deprecated Use MetricNamespaceQuery instead' } }, + withMetricDefinitionsQueryMixin(value): { grafanaTemplateVariableFn+: { MetricDefinitionsQuery+: value } }, + MetricDefinitionsQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['MetricDefinitionsQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { grafanaTemplateVariableFn+: { metricNamespace: value } }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { grafanaTemplateVariableFn+: { resourceGroup: value } }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { grafanaTemplateVariableFn+: { resourceName: value } }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { grafanaTemplateVariableFn+: { subscription: value } }, + }, + '#withMetricNamesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamesQuery(value): { grafanaTemplateVariableFn+: { MetricNamesQuery: value } }, + '#withMetricNamesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamesQueryMixin(value): { grafanaTemplateVariableFn+: { MetricNamesQuery+: value } }, + MetricNamesQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['MetricNamesQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { grafanaTemplateVariableFn+: { metricNamespace: value } }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { grafanaTemplateVariableFn+: { resourceGroup: value } }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { grafanaTemplateVariableFn+: { resourceName: value } }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { grafanaTemplateVariableFn+: { subscription: value } }, + }, + '#withWorkspacesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWorkspacesQuery(value): { grafanaTemplateVariableFn+: { WorkspacesQuery: value } }, + '#withWorkspacesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWorkspacesQueryMixin(value): { grafanaTemplateVariableFn+: { WorkspacesQuery+: value } }, + WorkspacesQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['WorkspacesQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { grafanaTemplateVariableFn+: { subscription: value } }, + }, + '#withUnknownQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnknownQuery(value): { grafanaTemplateVariableFn+: { UnknownQuery: value } }, + '#withUnknownQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnknownQueryMixin(value): { grafanaTemplateVariableFn+: { UnknownQuery+: value } }, + UnknownQuery+: + { + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { grafanaTemplateVariableFn+: { rawQuery: value } }, + '#withKind': { 'function': { args: [{ default: null, enums: ['UnknownQuery'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { grafanaTemplateVariableFn+: { kind: value } }, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNamespace(value): { namespace: value }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure Monitor query type.\nqueryType: #AzureQueryType' } }, + withRegion(value): { region: value }, + '#withResource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResource(value): { resource: value }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Template variables params. These exist for backwards compatiblity with legacy template variables.' } }, + withResourceGroup(value): { resourceGroup: value }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure subscription containing the resource(s) to be queried.' } }, + withSubscription(value): { subscription: value }, + '#withSubscriptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Subscriptions to be queried via Azure Resource Graph.' } }, + withSubscriptions(value): { subscriptions: (if std.isArray(value) + then value + else [value]) }, + '#withSubscriptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Subscriptions to be queried via Azure Resource Graph.' } }, + withSubscriptionsMixin(value): { subscriptions+: (if std.isArray(value) + then value + else [value]) }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/cloudWatch.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/cloudWatch.libsonnet new file mode 100644 index 0000000..53efbab --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/cloudWatch.libsonnet @@ -0,0 +1,310 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.cloudWatch', name: 'cloudWatch' }, + CloudWatchAnnotationQuery+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, + withAccountId(value): { accountId: value }, + '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensions(value): { dimensions: value }, + '#withDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensionsMixin(value): { dimensions+: value }, + '#withMatchExact': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only show metrics that exactly match all defined dimension names.' } }, + withMatchExact(value=true): { matchExact: value }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the metric' } }, + withMetricName(value): { metricName: value }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.' } }, + withNamespace(value): { namespace: value }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes" } }, + withPeriod(value): { period: value }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the metric' } }, + withRegion(value): { region: value }, + '#withStatistic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.' } }, + withStatistic(value): { statistic: value }, + '#withStatistics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatistics(value): { statistics: (if std.isArray(value) + then value + else [value]) }, + '#withStatisticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatisticsMixin(value): { statistics+: (if std.isArray(value) + then value + else [value]) }, + '#withActionPrefix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use this parameter to filter the results of the operation to only those alarms\nthat use a certain alarm action. For example, you could specify the ARN of\nan SNS topic to find all alarms that send notifications to that topic.\ne.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action`\nbut not match `arn:aws:sns:us-east-1:123456789012:your-app-action`' } }, + withActionPrefix(value): { actionPrefix: value }, + '#withAlarmNamePrefix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An alarm name prefix. If you specify this parameter, you receive information\nabout all alarms that have names that start with this prefix.\ne.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu`' } }, + withAlarmNamePrefix(value): { alarmNamePrefix: value }, + '#withPrefixMatching': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix' } }, + withPrefixMatching(value=true): { prefixMatching: value }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { queryMode: value }, + }, + CloudWatchLogsQuery+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The CloudWatch Logs Insights query to execute' } }, + withExpression(value): { expression: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withLogGroupNames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use logGroups' } }, + withLogGroupNames(value): { logGroupNames: (if std.isArray(value) + then value + else [value]) }, + '#withLogGroupNamesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use logGroups' } }, + withLogGroupNamesMixin(value): { logGroupNames+: (if std.isArray(value) + then value + else [value]) }, + '#withLogGroups': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Log groups to query' } }, + withLogGroups(value): { logGroups: (if std.isArray(value) + then value + else [value]) }, + '#withLogGroupsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Log groups to query' } }, + withLogGroupsMixin(value): { logGroups+: (if std.isArray(value) + then value + else [value]) }, + logGroups+: + { + '#': { help: '', name: 'logGroups' }, + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AccountId of the log group' } }, + withAccountId(value): { accountId: value }, + '#withAccountLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Label of the log group' } }, + withAccountLabel(value): { accountLabel: value }, + '#withArn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ARN of the log group' } }, + withArn(value): { arn: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the log group' } }, + withName(value): { name: value }, + }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { queryMode: value }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the logs' } }, + withRegion(value): { region: value }, + '#withStatsGroups': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Fields to group the results by, this field is automatically populated whenever the query is updated' } }, + withStatsGroups(value): { statsGroups: (if std.isArray(value) + then value + else [value]) }, + '#withStatsGroupsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Fields to group the results by, this field is automatically populated whenever the query is updated' } }, + withStatsGroupsMixin(value): { statsGroups+: (if std.isArray(value) + then value + else [value]) }, + }, + CloudWatchMetricsQuery+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, + withAccountId(value): { accountId: value }, + '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensions(value): { dimensions: value }, + '#withDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensionsMixin(value): { dimensions+: value }, + '#withMatchExact': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only show metrics that exactly match all defined dimension names.' } }, + withMatchExact(value=true): { matchExact: value }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the metric' } }, + withMetricName(value): { metricName: value }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.' } }, + withNamespace(value): { namespace: value }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes" } }, + withPeriod(value): { period: value }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the metric' } }, + withRegion(value): { region: value }, + '#withStatistic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.' } }, + withStatistic(value): { statistic: value }, + '#withStatistics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatistics(value): { statistics: (if std.isArray(value) + then value + else [value]) }, + '#withStatisticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatisticsMixin(value): { statistics+: (if std.isArray(value) + then value + else [value]) }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Deprecated: use label\n@deprecated use label' } }, + withAlias(value): { alias: value }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Math expression query' } }, + withExpression(value): { expression: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.' } }, + withId(value): { id: value }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.' } }, + withLabel(value): { label: value }, + '#withMetricEditorMode': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['integer'] }], help: '' } }, + withMetricEditorMode(value): { metricEditorMode: value }, + '#withMetricQueryType': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['integer'] }], help: '' } }, + withMetricQueryType(value): { metricQueryType: value }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { queryMode: value }, + '#withSql': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSql(value): { sql: value }, + '#withSqlMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSqlMixin(value): { sql+: value }, + sql+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'FROM part of the SQL expression' } }, + withFrom(value): { sql+: { from: value } }, + '#withFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'FROM part of the SQL expression' } }, + withFromMixin(value): { sql+: { from+: value } }, + from+: + { + '#withQueryEditorPropertyExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorPropertyExpression(value): { sql+: { from+: { QueryEditorPropertyExpression: value } } }, + '#withQueryEditorPropertyExpressionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorPropertyExpressionMixin(value): { sql+: { from+: { QueryEditorPropertyExpression+: value } } }, + QueryEditorPropertyExpression+: + { + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withProperty(value): { sql+: { from+: { property: value } } }, + '#withPropertyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPropertyMixin(value): { sql+: { from+: { property+: value } } }, + property+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { sql+: { from+: { property+: { name: value } } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['string'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { sql+: { from+: { property+: { type: value } } } }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { sql+: { from+: { type: value } } }, + }, + '#withQueryEditorFunctionExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorFunctionExpression(value): { sql+: { from+: { QueryEditorFunctionExpression: value } } }, + '#withQueryEditorFunctionExpressionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorFunctionExpressionMixin(value): { sql+: { from+: { QueryEditorFunctionExpression+: value } } }, + QueryEditorFunctionExpression+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { sql+: { from+: { name: value } } }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { sql+: { from+: { parameters: (if std.isArray(value) + then value + else [value]) } } }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { sql+: { from+: { parameters+: (if std.isArray(value) + then value + else [value]) } } }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { sql+: { from+: { type: value } } }, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withGroupBy(value): { sql+: { groupBy: value } }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withGroupByMixin(value): { sql+: { groupBy+: value } }, + groupBy+: + { + '#withExpressions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressions(value): { sql+: { groupBy+: { expressions: (if std.isArray(value) + then value + else [value]) } } }, + '#withExpressionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressionsMixin(value): { sql+: { groupBy+: { expressions+: (if std.isArray(value) + then value + else [value]) } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { sql+: { groupBy+: { type: value } } }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'LIMIT part of the SQL expression' } }, + withLimit(value): { sql+: { limit: value } }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderBy(value): { sql+: { orderBy: value } }, + '#withOrderByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderByMixin(value): { sql+: { orderBy+: value } }, + orderBy+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { sql+: { orderBy+: { name: value } } }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { sql+: { orderBy+: { parameters: (if std.isArray(value) + then value + else [value]) } } }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { sql+: { orderBy+: { parameters+: (if std.isArray(value) + then value + else [value]) } } }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { sql+: { orderBy+: { type: value } } }, + }, + '#withOrderByDirection': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The sort order of the SQL expression, `ASC` or `DESC`' } }, + withOrderByDirection(value): { sql+: { orderByDirection: value } }, + '#withSelect': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSelect(value): { sql+: { select: value } }, + '#withSelectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSelectMixin(value): { sql+: { select+: value } }, + select+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { sql+: { select+: { name: value } } }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { sql+: { select+: { parameters: (if std.isArray(value) + then value + else [value]) } } }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { sql+: { select+: { parameters+: (if std.isArray(value) + then value + else [value]) } } }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { sql+: { select+: { type: value } } }, + }, + '#withWhere': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWhere(value): { sql+: { where: value } }, + '#withWhereMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWhereMixin(value): { sql+: { where+: value } }, + where+: + { + '#withExpressions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressions(value): { sql+: { where+: { expressions: (if std.isArray(value) + then value + else [value]) } } }, + '#withExpressionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressionsMixin(value): { sql+: { where+: { expressions+: (if std.isArray(value) + then value + else [value]) } } }, + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { sql+: { where+: { type: value } } }, + }, + }, + '#withSqlExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string.' } }, + withSqlExpression(value): { sqlExpression: value }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/elasticsearch.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/elasticsearch.libsonnet new file mode 100644 index 0000000..b8717af --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/elasticsearch.libsonnet @@ -0,0 +1,763 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.elasticsearch', name: 'elasticsearch' }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alias pattern' } }, + withAlias(value): { alias: value }, + '#withBucketAggs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of bucket aggregations' } }, + withBucketAggs(value): { bucketAggs: (if std.isArray(value) + then value + else [value]) }, + '#withBucketAggsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of bucket aggregations' } }, + withBucketAggsMixin(value): { bucketAggs+: (if std.isArray(value) + then value + else [value]) }, + bucketAggs+: + { + '#': { help: '', name: 'bucketAggs' }, + DateHistogram+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInterval(value): { settings+: { interval: value } }, + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { settings+: { min_doc_count: value } }, + '#withOffset': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOffset(value): { settings+: { offset: value } }, + '#withTimeZone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTimeZone(value): { settings+: { timeZone: value } }, + '#withTrimEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTrimEdges(value): { settings+: { trimEdges: value } }, + }, + }, + Histogram+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInterval(value): { settings+: { interval: value } }, + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { settings+: { min_doc_count: value } }, + }, + }, + Terms+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { settings+: { min_doc_count: value } }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { settings+: { missing: value } }, + '#withOrder': { 'function': { args: [{ default: null, enums: ['desc', 'asc'], name: 'value', type: ['string'] }], help: '' } }, + withOrder(value): { settings+: { order: value } }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrderBy(value): { settings+: { orderBy: value } }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { settings+: { size: value } }, + }, + }, + Filters+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { settings+: { filters: (if std.isArray(value) + then value + else [value]) } }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { settings+: { filters+: (if std.isArray(value) + then value + else [value]) } }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabel(value): { label: value }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value): { query: value }, + }, + }, + }, + GeoHashGrid+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withPrecision': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPrecision(value): { settings+: { precision: value } }, + }, + }, + Nested+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of metric aggregations' } }, + withMetrics(value): { metrics: (if std.isArray(value) + then value + else [value]) }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of metric aggregations' } }, + withMetricsMixin(value): { metrics+: (if std.isArray(value) + then value + else [value]) }, + metrics+: + { + '#': { help: '', name: 'metrics' }, + Count+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + }, + PipelineMetricAggregation+: + { + MovingAverage+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + }, + Derivative+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { settings+: { unit: value } }, + }, + }, + CumulativeSum+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { settings+: { format: value } }, + }, + }, + BucketScript+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withPipelineVariables': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariables(value): { pipelineVariables: (if std.isArray(value) + then value + else [value]) }, + '#withPipelineVariablesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariablesMixin(value): { pipelineVariables+: (if std.isArray(value) + then value + else [value]) }, + pipelineVariables+: + { + '#': { help: '', name: 'pipelineVariables' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + }, + }, + }, + MetricAggregationWithSettings+: + { + BucketScript+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withPipelineVariables': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariables(value): { pipelineVariables: (if std.isArray(value) + then value + else [value]) }, + '#withPipelineVariablesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariablesMixin(value): { pipelineVariables+: (if std.isArray(value) + then value + else [value]) }, + pipelineVariables+: + { + '#': { help: '', name: 'pipelineVariables' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + }, + }, + CumulativeSum+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { settings+: { format: value } }, + }, + }, + Derivative+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { settings+: { unit: value } }, + }, + }, + SerialDiff+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withLag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLag(value): { settings+: { lag: value } }, + }, + }, + RawData+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { settings+: { size: value } }, + }, + }, + RawDocument+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { settings+: { size: value } }, + }, + }, + UniqueCount+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { settings+: { missing: value } }, + '#withPrecisionThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPrecisionThreshold(value): { settings+: { precision_threshold: value } }, + }, + }, + Percentiles+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { settings+: { missing: value } }, + '#withPercents': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPercents(value): { settings+: { percents: (if std.isArray(value) + then value + else [value]) } }, + '#withPercentsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPercentsMixin(value): { settings+: { percents+: (if std.isArray(value) + then value + else [value]) } }, + }, + }, + ExtendedStats+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { settings+: { missing: value } }, + '#withSigma': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSigma(value): { settings+: { sigma: value } }, + }, + '#withMeta': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMeta(value): { meta: value }, + '#withMetaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetaMixin(value): { meta+: value }, + }, + Min+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { settings+: { missing: value } }, + }, + }, + Max+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { settings+: { missing: value } }, + }, + }, + Sum+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { settings+: { missing: value } }, + }, + }, + Average+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { settings+: { missing: value } }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + }, + }, + MovingAverage+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + }, + MovingFunction+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { pipelineAgg: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { settings+: { script: value } }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { settings+: { script+: value } }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { settings+: { script+: { inline: value } } }, + }, + '#withShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withShift(value): { settings+: { shift: value } }, + '#withWindow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWindow(value): { settings+: { window: value } }, + }, + }, + Logs+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLimit(value): { settings+: { limit: value } }, + }, + }, + Rate+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { field: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { settings+: { mode: value } }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { settings+: { unit: value } }, + }, + }, + TopMetrics+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { hide: value }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { id: value }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { type: value }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { settings: value }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { settings+: value }, + settings+: + { + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetrics(value): { settings+: { metrics: (if std.isArray(value) + then value + else [value]) } }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetricsMixin(value): { settings+: { metrics+: (if std.isArray(value) + then value + else [value]) } }, + '#withOrder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrder(value): { settings+: { order: value } }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrderBy(value): { settings+: { orderBy: value } }, + }, + }, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Lucene query' } }, + withQuery(value): { query: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withTimeField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of time field' } }, + withTimeField(value): { timeField: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/googleCloudMonitoring.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/googleCloudMonitoring.libsonnet new file mode 100644 index 0000000..765c385 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/googleCloudMonitoring.libsonnet @@ -0,0 +1,122 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.googleCloudMonitoring', name: 'googleCloudMonitoring' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withAliasBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.' } }, + withAliasBy(value): { aliasBy: value }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Time interval in milliseconds.' } }, + withIntervalMs(value): { intervalMs: value }, + '#withPromQLQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'PromQL sub-query properties.' } }, + withPromQLQuery(value): { promQLQuery: value }, + '#withPromQLQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'PromQL sub-query properties.' } }, + withPromQLQueryMixin(value): { promQLQuery+: value }, + promQLQuery+: + { + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'PromQL expression/query to be executed.' } }, + withExpr(value): { promQLQuery+: { expr: value } }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { promQLQuery+: { projectName: value } }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'PromQL min step' } }, + withStep(value): { promQLQuery+: { step: value } }, + }, + '#withSloQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SLO sub-query properties.' } }, + withSloQuery(value): { sloQuery: value }, + '#withSloQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SLO sub-query properties.' } }, + withSloQueryMixin(value): { sloQuery+: value }, + sloQuery+: + { + '#withAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withAlignmentPeriod(value): { sloQuery+: { alignmentPeriod: value } }, + '#withGoal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'SLO goal value.' } }, + withGoal(value): { sloQuery+: { goal: value } }, + '#withLookbackPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific lookback period for the SLO.' } }, + withLookbackPeriod(value): { sloQuery+: { lookbackPeriod: value } }, + '#withPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withPerSeriesAligner(value): { sloQuery+: { perSeriesAligner: value } }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { sloQuery+: { projectName: value } }, + '#withSelectorName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'SLO selector.' } }, + withSelectorName(value): { sloQuery+: { selectorName: value } }, + '#withServiceId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID for the service the SLO is in.' } }, + withServiceId(value): { sloQuery+: { serviceId: value } }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name for the service the SLO is in.' } }, + withServiceName(value): { sloQuery+: { serviceName: value } }, + '#withSloId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID for the SLO.' } }, + withSloId(value): { sloQuery+: { sloId: value } }, + '#withSloName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the SLO.' } }, + withSloName(value): { sloQuery+: { sloName: value } }, + }, + '#withTimeSeriesList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series List sub-query properties.' } }, + withTimeSeriesList(value): { timeSeriesList: value }, + '#withTimeSeriesListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series List sub-query properties.' } }, + withTimeSeriesListMixin(value): { timeSeriesList+: value }, + timeSeriesList+: + { + '#withAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withAlignmentPeriod(value): { timeSeriesList+: { alignmentPeriod: value } }, + '#withCrossSeriesReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.' } }, + withCrossSeriesReducer(value): { timeSeriesList+: { crossSeriesReducer: value } }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of filters to query data by. Labels that can be filtered on are defined by the metric.' } }, + withFilters(value): { timeSeriesList+: { filters: (if std.isArray(value) + then value + else [value]) } }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of filters to query data by. Labels that can be filtered on are defined by the metric.' } }, + withFiltersMixin(value): { timeSeriesList+: { filters+: (if std.isArray(value) + then value + else [value]) } }, + '#withGroupBys': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of labels to group data by.' } }, + withGroupBys(value): { timeSeriesList+: { groupBys: (if std.isArray(value) + then value + else [value]) } }, + '#withGroupBysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of labels to group data by.' } }, + withGroupBysMixin(value): { timeSeriesList+: { groupBys+: (if std.isArray(value) + then value + else [value]) } }, + '#withPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withPerSeriesAligner(value): { timeSeriesList+: { perSeriesAligner: value } }, + '#withPreprocessor': { 'function': { args: [{ default: null, enums: ['none', 'rate', 'delta'], name: 'value', type: ['string'] }], help: 'Types of pre-processor available. Defined by the metric.' } }, + withPreprocessor(value): { timeSeriesList+: { preprocessor: value } }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { timeSeriesList+: { projectName: value } }, + '#withSecondaryAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withSecondaryAlignmentPeriod(value): { timeSeriesList+: { secondaryAlignmentPeriod: value } }, + '#withSecondaryCrossSeriesReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.' } }, + withSecondaryCrossSeriesReducer(value): { timeSeriesList+: { secondaryCrossSeriesReducer: value } }, + '#withSecondaryGroupBys': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only present if a preprocessor is selected. Array of labels to group data by.' } }, + withSecondaryGroupBys(value): { timeSeriesList+: { secondaryGroupBys: (if std.isArray(value) + then value + else [value]) } }, + '#withSecondaryGroupBysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only present if a preprocessor is selected. Array of labels to group data by.' } }, + withSecondaryGroupBysMixin(value): { timeSeriesList+: { secondaryGroupBys+: (if std.isArray(value) + then value + else [value]) } }, + '#withSecondaryPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withSecondaryPerSeriesAligner(value): { timeSeriesList+: { secondaryPerSeriesAligner: value } }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Annotation text.' } }, + withText(value): { timeSeriesList+: { text: value } }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Annotation title.' } }, + withTitle(value): { timeSeriesList+: { title: value } }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Data view, defaults to FULL.' } }, + withView(value): { timeSeriesList+: { view: value } }, + }, + '#withTimeSeriesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series sub-query properties.' } }, + withTimeSeriesQuery(value): { timeSeriesQuery: value }, + '#withTimeSeriesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series sub-query properties.' } }, + withTimeSeriesQueryMixin(value): { timeSeriesQuery+: value }, + timeSeriesQuery+: + { + '#withGraphPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "To disable the graphPeriod, it should explictly be set to 'disabled'." } }, + withGraphPeriod(value): { timeSeriesQuery+: { graphPeriod: value } }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { timeSeriesQuery+: { projectName: value } }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'MQL query to be executed.' } }, + withQuery(value): { timeSeriesQuery+: { query: value } }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/grafanaPyroscope.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/grafanaPyroscope.libsonnet new file mode 100644 index 0000000..97a393c --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/grafanaPyroscope.libsonnet @@ -0,0 +1,26 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.grafanaPyroscope', name: 'grafanaPyroscope' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, + withGroupBy(value): { groupBy: (if std.isArray(value) + then value + else [value]) }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, + withGroupByMixin(value): { groupBy+: (if std.isArray(value) + then value + else [value]) }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, + withLabelSelector(value='{}'): { labelSelector: value }, + '#withMaxNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the maximum number of nodes in the flamegraph.' } }, + withMaxNodes(value): { maxNodes: value }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, + withProfileTypeId(value): { profileTypeId: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/loki.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/loki.libsonnet new file mode 100644 index 0000000..4760476 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/loki.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.loki', name: 'loki' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { editorMode: value }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The LogQL query.' } }, + withExpr(value): { expr: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, + withInstant(value=true): { instant: value }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to override the name of the series.' } }, + withLegendFormat(value): { legendFormat: value }, + '#withMaxLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Used to limit the number of log rows returned.' } }, + withMaxLines(value): { maxLines: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, + withRange(value=true): { range: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withResolution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '@deprecated, now use step.' } }, + withResolution(value): { resolution: value }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to set step value for range queries.' } }, + withStep(value): { step: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/parca.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/parca.libsonnet new file mode 100644 index 0000000..6810272 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/parca.libsonnet @@ -0,0 +1,16 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.parca', name: 'parca' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, + withLabelSelector(value='{}'): { labelSelector: value }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, + withProfileTypeId(value): { profileTypeId: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/prometheus.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/prometheus.libsonnet new file mode 100644 index 0000000..6bf1c9e --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/prometheus.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.prometheus', name: 'prometheus' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { editorMode: value }, + '#withExemplar': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Execute an additional query to identify interesting raw samples relevant for the given expr' } }, + withExemplar(value=true): { exemplar: value }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The actual expression/query that will be evaluated by Prometheus' } }, + withExpr(value): { expr: value }, + '#withFormat': { 'function': { args: [{ default: null, enums: ['time_series', 'table', 'heatmap'], name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { format: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns only the latest value that Prometheus has scraped for the requested time series' } }, + withInstant(value=true): { instant: value }, + '#withIntervalFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '@deprecated Used to specify how many times to divide max data points by. We use max data points under query options\nSee https://github.com/grafana/grafana/issues/48081' } }, + withIntervalFactor(value): { intervalFactor: value }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname' } }, + withLegendFormat(value): { legendFormat: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series' } }, + withRange(value=true): { range: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/tempo.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/tempo.libsonnet new file mode 100644 index 0000000..ee88b43 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/tempo.libsonnet @@ -0,0 +1,86 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.tempo', name: 'tempo' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { filters: (if std.isArray(value) + then value + else [value]) }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { filters+: (if std.isArray(value) + then value + else [value]) }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { id: value }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { operator: value }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { scope: value }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { tag: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { value: value }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { value+: value }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { valueType: value }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupBy(value): { groupBy: (if std.isArray(value) + then value + else [value]) }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupByMixin(value): { groupBy+: (if std.isArray(value) + then value + else [value]) }, + groupBy+: + { + '#': { help: '', name: 'groupBy' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { id: value }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { operator: value }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { scope: value }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { tag: value }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { value: value }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { value+: value }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { valueType: value }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of traces that are returned from Tempo' } }, + withLimit(value): { limit: value }, + '#withMaxDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMaxDuration(value): { maxDuration: value }, + '#withMinDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMinDuration(value): { minDuration: value }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TraceQL query or trace ID' } }, + withQuery(value): { query: value }, + '#withSearch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true' } }, + withSearch(value): { search: value }, + '#withServiceMapIncludeNamespace': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Use service.namespace in addition to service.name to uniquely identify a service.' } }, + withServiceMapIncludeNamespace(value=true): { serviceMapIncludeNamespace: value }, + '#withServiceMapQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}' } }, + withServiceMapQuery(value): { serviceMapQuery: value }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by service name' } }, + withServiceName(value): { serviceName: value }, + '#withSpanName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by span name' } }, + withSpanName(value): { spanName: value }, + '#withSpss': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of spans per spanset that are returned from Tempo' } }, + withSpss(value): { spss: value }, + '#withTableType': { 'function': { args: [{ default: null, enums: ['traces', 'spans'], name: 'value', type: ['string'] }], help: 'The type of the table that is used to display the search results' } }, + withTableType(value): { tableType: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/testData.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/testData.libsonnet new file mode 100644 index 0000000..85af1bd --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/query/testData.libsonnet @@ -0,0 +1,172 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.testData', name: 'testData' }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlias(value): { alias: value }, + '#withChannel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withChannel(value): { channel: value }, + '#withCsvContent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCsvContent(value): { csvContent: value }, + '#withCsvFileName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCsvFileName(value): { csvFileName: value }, + '#withCsvWave': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCsvWave(value): { csvWave: (if std.isArray(value) + then value + else [value]) }, + '#withCsvWaveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCsvWaveMixin(value): { csvWave+: (if std.isArray(value) + then value + else [value]) }, + csvWave+: + { + '#': { help: '', name: 'csvWave' }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabels(value): { labels: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { name: value }, + '#withTimeStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withTimeStep(value): { timeStep: value }, + '#withValuesCSV': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValuesCSV(value): { valuesCSV: value }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { datasource: value }, + '#withDropPercent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Drop percentage (the chance we will lose a point 0-100)' } }, + withDropPercent(value): { dropPercent: value }, + '#withErrorType': { 'function': { args: [{ default: null, enums: ['server_panic', 'frontend_exception', 'frontend_observable'], name: 'value', type: ['string'] }], help: '' } }, + withErrorType(value): { errorType: value }, + '#withFlamegraphDiff': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFlamegraphDiff(value=true): { flamegraphDiff: value }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { hide: value }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabels(value): { labels: value }, + '#withLevelColumn': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLevelColumn(value=true): { levelColumn: value }, + '#withLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLines(value): { lines: value }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { nodes: value }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { nodes+: value }, + nodes+: + { + '#withCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withCount(value): { nodes+: { count: value } }, + '#withType': { 'function': { args: [{ default: null, enums: ['random', 'response', 'random edges'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { nodes+: { type: value } }, + }, + '#withPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPoints(value): { points: (if std.isArray(value) + then value + else [value]) }, + '#withPointsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPointsMixin(value): { points+: (if std.isArray(value) + then value + else [value]) }, + '#withPulseWave': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPulseWave(value): { pulseWave: value }, + '#withPulseWaveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPulseWaveMixin(value): { pulseWave+: value }, + pulseWave+: + { + '#withOffCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOffCount(value): { pulseWave+: { offCount: value } }, + '#withOffValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withOffValue(value): { pulseWave+: { offValue: value } }, + '#withOnCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOnCount(value): { pulseWave+: { onCount: value } }, + '#withOnValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withOnValue(value): { pulseWave+: { onValue: value } }, + '#withTimeStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withTimeStep(value): { pulseWave+: { timeStep: value } }, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { queryType: value }, + '#withRawFrameContent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawFrameContent(value): { rawFrameContent: value }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { refId: value }, + '#withScenarioId': { 'function': { args: [{ default: null, enums: ['random_walk', 'slow_query', 'random_walk_with_error', 'random_walk_table', 'exponential_heatmap_bucket_data', 'linear_heatmap_bucket_data', 'no_data_points', 'datapoints_outside_range', 'csv_metric_values', 'predictable_pulse', 'predictable_csv_wave', 'streaming_client', 'simulation', 'usa', 'live', 'grafana_api', 'arrow', 'annotations', 'table_static', 'server_error_500', 'logs', 'node_graph', 'flame_graph', 'raw_frame', 'csv_file', 'csv_content', 'trace', 'manual_entry', 'variables-query'], name: 'value', type: ['string'] }], help: '' } }, + withScenarioId(value): { scenarioId: value }, + '#withSeriesCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSeriesCount(value): { seriesCount: value }, + '#withSim': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSim(value): { sim: value }, + '#withSimMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSimMixin(value): { sim+: value }, + sim+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConfig(value): { sim+: { config: value } }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConfigMixin(value): { sim+: { config+: value } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withKey(value): { sim+: { key: value } }, + '#withKeyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withKeyMixin(value): { sim+: { key+: value } }, + key+: + { + '#withTick': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTick(value): { sim+: { key+: { tick: value } } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { sim+: { key+: { type: value } } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUid(value): { sim+: { key+: { uid: value } } }, + }, + '#withLast': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLast(value=true): { sim+: { last: value } }, + '#withStream': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withStream(value=true): { sim+: { stream: value } }, + }, + '#withSpanCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSpanCount(value): { spanCount: value }, + '#withStream': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStream(value): { stream: value }, + '#withStreamMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStreamMixin(value): { stream+: value }, + stream+: + { + '#withBands': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withBands(value): { stream+: { bands: value } }, + '#withNoise': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withNoise(value): { stream+: { noise: value } }, + '#withSpeed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSpeed(value): { stream+: { speed: value } }, + '#withSpread': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSpread(value): { stream+: { spread: value } }, + '#withType': { 'function': { args: [{ default: null, enums: ['signal', 'logs', 'fetch'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { stream+: { type: value } }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUrl(value): { stream+: { url: value } }, + }, + '#withStringInput': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringInput(value): { stringInput: value }, + '#withUsa': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUsa(value): { usa: value }, + '#withUsaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUsaMixin(value): { usa+: value }, + usa+: + { + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { usa+: { fields: (if std.isArray(value) + then value + else [value]) } }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { usa+: { fields+: (if std.isArray(value) + then value + else [value]) } }, + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { usa+: { mode: value } }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPeriod(value): { usa+: { period: value } }, + '#withStates': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withStates(value): { usa+: { states: (if std.isArray(value) + then value + else [value]) } }, + '#withStatesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withStatesMixin(value): { usa+: { states+: (if std.isArray(value) + then value + else [value]) } }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/role.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/role.libsonnet new file mode 100644 index 0000000..5909f53 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/role.libsonnet @@ -0,0 +1,14 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.role', name: 'role' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Role description' } }, + withDescription(value): { description: value }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display' } }, + withDisplayName(value): { displayName: value }, + '#withGroupName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, + withGroupName(value): { groupName: value }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Do not show this role' } }, + withHidden(value=true): { hidden: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The role identifier `managed:builtins:editor:permissions`' } }, + withName(value): { name: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/rolebinding.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/rolebinding.libsonnet new file mode 100644 index 0000000..7c16662 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/rolebinding.libsonnet @@ -0,0 +1,44 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.rolebinding', name: 'rolebinding' }, + '#withRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The role we are discussing' } }, + withRole(value): { role: value }, + '#withRoleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The role we are discussing' } }, + withRoleMixin(value): { role+: value }, + role+: + { + '#withBuiltinRoleRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBuiltinRoleRef(value): { role+: { BuiltinRoleRef: value } }, + '#withBuiltinRoleRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBuiltinRoleRefMixin(value): { role+: { BuiltinRoleRef+: value } }, + BuiltinRoleRef+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['BuiltinRole'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { role+: { kind: value } }, + '#withName': { 'function': { args: [{ default: null, enums: ['viewer', 'editor', 'admin'], name: 'value', type: ['string'] }], help: '' } }, + withName(value): { role+: { name: value } }, + }, + '#withCustomRoleRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomRoleRef(value): { role+: { CustomRoleRef: value } }, + '#withCustomRoleRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomRoleRefMixin(value): { role+: { CustomRoleRef+: value } }, + CustomRoleRef+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Role'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { role+: { kind: value } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { role+: { name: value } }, + }, + }, + '#withSubject': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubject(value): { subject: value }, + '#withSubjectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubjectMixin(value): { subject+: value }, + subject+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Team', 'User'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { subject+: { kind: value } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The team/user identifier name' } }, + withName(value): { subject+: { name: value } }, + }, +} diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/team.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/team.libsonnet new file mode 100644 index 0000000..1fbda59 --- /dev/null +++ b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.2.0/raw/team.libsonnet @@ -0,0 +1,8 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.team', name: 'team' }, + '#withEmail': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Email of the team.' } }, + withEmail(value): { email: value }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, + withName(value): { name: value }, +} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/helpers.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/helpers.libsonnet deleted file mode 100644 index 28d85b4..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/helpers.libsonnet +++ /dev/null @@ -1,173 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -{ - local root = self, - - // Grabs last item in an array - last(arr): xtd.array.slice(arr, -1)[0], - - // Returns the whole array except the last item - allButLast(arr): xtd.array.slice(arr, 0, -1), - - // Gets the content from source on a specified JSONPath - getContent(source, path): - xtd.jsonpath.getJSONPath(source, path), - - // Sets the content on a specified ~JSONPath - setContent(content, path): - std.foldr( - function(k, acc) - { [k]+: acc }, - xtd.string.splitEscape(path, '.'), - content - ), - - // Hides the content in source on a specified ~JSONPath - hideContent(source, path): - local splitPath = xtd.string.splitEscape(path, '.'); - local content = root.getContent(source, path); - std.foldr( - function(k, acc) - { [k]+: acc }, - root.allButLast(splitPath), - { [root.last(splitPath)]:: content } - ), - - // Removes the content in source on a specified ~JSONPath - removeContent(source, path): - local splitPath = xtd.string.splitEscape(path, '.'); - std.foldr( - function(k, acc) - { [k]+: acc }, - root.allButLast(splitPath), - { [root.last(splitPath)]:: {} } - ), - - // Transform moves the content from JSONPath `from` to JSONPath `to` in `source` - transform(source, from, to): - local content = root.getContent(source, from); - if content == null - then {} - else root.setContent(content, to) - , - - // This functions transforms the canonical groupings representation to an array that can - // be processed by `transform()`. Example groupings object: - // local groupings = { - // toPath: [ - // 'from.path.one', - // 'from.path.two', - // ], - // }, - groupingsToTransformArray(groupings, keyPrefix='', keySuffix='', separator='.'): - [ - { - local splitFromPath = xtd.string.splitEscape(fromPath, '.'), - local lastKey = - keyPrefix - + root.last(splitFromPath) - + keySuffix, - - from: - std.join( - separator, - root.allButLast(splitFromPath) - + [lastKey], - ), - to: - toPath - + separator - + lastKey, - } - for toPath in std.objectFields(groupings) - for fromPath in groupings[toPath] - ], - - // Transforms a groupings object from source, including their docstring counterparts - group(source, groupings): - std.foldl( - function(acc, mapping) - acc - + root.transform(source, mapping.from, mapping.to), - root.groupingsToTransformArray(groupings) - + root.groupingsToTransformArray(groupings, '#'), // also regroup docstrings - {} - ), - - // Transforms a groupings object from source, including their docstring counterparts - // Regroup means it gets merged with the `source`. - regroup(source, groupings, base=source): - std.foldl( - function(acc, mapping) - acc - + root.transform( - source, - mapping.from, - mapping.to - ), - root.groupingsToTransformArray(groupings) - + root.groupingsToTransformArray(groupings, '#'), // also regroup docstrings - base - ) - + std.foldl( - function(acc, mapping) - acc - + root.removeContent( - source, - mapping.from - ), - root.groupingsToTransformArray(groupings, '#'), - base - ), - - // Creates a (docs) subpackage from `source` and places it at `to`. - makeSubpackage(source, from, to, docstring=''): - local splitFrom = xtd.string.splitEscape(from, '.'); - local splitTo = xtd.string.splitEscape(to, '.'); - local content = { - '#':: d.package.newSub(root.last(splitTo), docstring), - }; - - root.removeContent( // Hide docstring on root - source, - std.join( - '.', - root.allButLast(splitFrom) - + ['#' + root.last(splitFrom)], - ) - ) - + root.transform(source, from, to) - + root.setContent(content, to), - - // Repackages a field from `source` according to the mapping data. - // local data = [ - // { - // from: 'fromPath', - // to: 'toPath', - // docstring: '', - // }, - // ], - repackage(source, data): - std.foldl( - function(acc, mapping) - acc + - root.makeSubpackage( - source, - mapping.from, - mapping.to, - mapping.docstring - ), - data, - {} - ), - - // Remove fields from `source`, `paths` is an array of path strings - removePaths(source, paths): - std.foldl( - function(acc, path) - acc + root.removeContent(source, path), - paths, - {} - ), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/jsonnetfile.json b/vendor/github.com/grafana/grafonnet/grafonnet-base/jsonnetfile.json deleted file mode 100644 index fa63410..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/jsonnetfile.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/crdsonnet.git", - "subdir": "crdsonnet" - } - }, - "version": "master" - } - ], - "legacyImports": true -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/main.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/main.libsonnet deleted file mode 100644 index 625e285..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/main.libsonnet +++ /dev/null @@ -1,346 +0,0 @@ -local crdsonnet = import 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -local util = import './util/main.libsonnet'; -local veneer = import './veneer/main.libsonnet'; - -{ - local root = self, - - // Some plugins are named differently, this has been resolved in the Grafana code base - // but no reflected in the JSON schema. - // source: https://github.com/grafana/grafana/blob/0ee9d11a9148f517fed57bd4c9b840480993cf42/pkg/kindsys/report.go#L285 - local irregularPluginNames = { - // Panel - alertgroups: 'alertGroups', - annotationslist: 'annolist', - dashboardlist: 'dashlist', - nodegraph: 'nodeGraph', - statetimeline: 'state-timeline', - statushistory: 'status-history', - tableold: 'table-old', - // Datasource - googlecloudmonitoring: 'cloud-monitoring', - azuremonitor: 'grafana-azure-monitor-datasource', - microsoftsqlserver: 'mssql', - postgresql: 'postgres', - }, - - // Used to fake render missing schemas - local genericSchema(title) = - root.restructure({ - info: { - title: title, - }, - components: { - schemas: { - [title]: { - type: 'object', - }, - }, - }, - }), - - new(schemas, version): - local dashboardSchema = std.filter( - function(schema) schema.info.title == 'dashboard', - schemas - )[0]; - - local allSchemaTitles = std.map(function(x) x.info.title, schemas); - - local filteredSchemas = { - core: std.filterMap( - function(schema) - !std.endsWith(schema.info.title, 'PanelCfg') - && !std.endsWith(schema.info.title, 'DataQuery'), - function(schema) root.restructure(schema), - schemas - ), - - local missingPanelSchemas = [ - 'CandlestickPanelCfg', - 'CanvasPanelCfg', - ], - panel: - [ - genericSchema(title) - for title in missingPanelSchemas - if !std.member(allSchemaTitles, title) - ] - + std.filterMap( - function(schema) std.endsWith(schema.info.title, 'PanelCfg'), - function(schema) root.restructure(schema), - schemas - ), - - query: std.filterMap( - function(schema) std.endsWith(schema.info.title, 'DataQuery'), - function(schema) root.restructure(schema), - schemas, - ), - }; - - { - [schema.info.title]: - root.coreLib.new(schema) - for schema in filteredSchemas.core - } - + { - [k]: - { - [schema.info.title]: - root[k + 'Lib'].new(dashboardSchema, schema) - for schema in filteredSchemas[k] - } - + root.packageDocMixin(k, '') - for k in std.objectFields(filteredSchemas) - if k != 'core' - } - + { - panel+: { - row: - root.rowPanelLib.new(dashboardSchema), - }, - - // Add docs - '#': - d.package.new( - 'grafonnet', - 'github.com/grafana/grafonnet/gen/grafonnet-%s' % version, - 'Jsonnet library for rendering Grafana resources', - 'main.libsonnet', - 'main', - ), - - // Add util functions - util: util, - }, - - - packageDocMixin(name, path): - { - '#': - d.package.newSub( - name, - 'grafonnet.%(path)s%(name)s' % { name: name, path: path } - ), - }, - - formatPanelName(name): - local woDataQuery = std.strReplace(name, 'DataQuery', ''); - local woPanelCfg = std.strReplace(woDataQuery, 'PanelCfg', ''); - local split = xtd.camelcase.split(woPanelCfg); - std.join( - '', - [std.asciiLower(split[0])] - + split[1:] - ), - - restructure(schema): - local title = schema.info.title; - local formatted = root.formatPanelName(title); - - local schemaFixes = { - CloudWatchDataQuery: { - [formatted]: { - type: 'object', - oneOf: [ - { '$ref': '#/components/schemas/CloudWatchAnnotationQuery' }, - { '$ref': '#/components/schemas/CloudWatchLogsQuery' }, - { '$ref': '#/components/schemas/CloudWatchMetricsQuery' }, - ], - }, - - QueryEditorArrayExpression+: { - properties+: { - // Prevent infinite recursion - expressions+: { items: {} }, - }, - }, - }, - AzureMonitorDataQuery: { - [formatted]: { - '$ref': '#/components/schemas/AzureMonitorQuery', - }, - }, - TempoDataQuery: { - [formatted]: { - '$ref': '#/components/schemas/TempoQuery', - }, - }, - }; - - schema { - info+: { - title: formatted, - }, - components+: { - schemas+: - // FIXME: Some schemas follow a different structure, temporarily covering for this. - std.get( - schemaFixes, - title, - { [formatted]: super[title] } - ), - }, - } - , - - docs(main): - d.render(main), - - coreLib: { - new(schema): - local title = schema.info.title; - local spec = - if 'spec' in schema.components.schemas[title].properties - then schema.components.schemas[title].properties.spec - else schema.components.schemas[title]; - - local render = crdsonnet.fromOpenAPI( - 'lib', - spec, - schema, - render='dynamic', - ); - if 'lib' in render - then - render.lib - + root.packageDocMixin(title, '') - + veneer.core(title) - else {}, - }, - - queryLib: { - new(dashboardSchema, schema): - local title = schema.info.title; - local render = crdsonnet.fromOpenAPI( - 'lib', - schema.components.schemas[title], - schema, - render='dynamic', - ); - if 'lib' in render - then - render.lib - + root.packageDocMixin(title, 'query.') - + veneer.query(title) - else {}, - }, - - panelLib: { - // The panelSchema has PanelOptions and PanelFieldConfig that need to replace certain - // fiels in the upstream Panel schema This function fits these schemas in the right - // place for CRDsonnet. - new(dashboardSchema, panelSchema): - local title = panelSchema.info.title; - local subSchema = panelSchema.components.schemas[panelSchema.info.title]; - local customSubSchema = - panelSchema.components.schemas[panelSchema.info.title] { - type: 'object', - [if 'properties' in subSchema then 'properties']+: { - [if 'PanelOptions' in subSchema.properties then 'options']: - subSchema.properties.PanelOptions, - [if 'PanelFieldConfig' in subSchema.properties then 'fieldConfig']: { - type: 'object', - properties+: { - defaults+: { - type: 'object', - properties+: { - custom: subSchema.properties.PanelFieldConfig, - }, - }, - }, - }, - }, - }; - - local customPanelSchema = - dashboardSchema.components.schemas.Panel { - properties+: { - type: { - const: - std.get( - irregularPluginNames, - std.asciiLower(title), - std.asciiLower(title), - ), - }, - }, - }; - - local parsed = - crdsonnet.fromOpenAPI( - 'customLib', - customSubSchema, - panelSchema, - render='dynamic', - ) - + crdsonnet.fromOpenAPI( - 'panelLib', - customPanelSchema, - dashboardSchema, - render='dynamic', - ); - - local panel = parsed.panelLib + ( - if 'customLib' in parsed - then { - [if 'options' in parsed.customLib then 'options']: - parsed.customLib.options, - [if 'fieldConfig' in parsed.customLib then 'fieldConfig']+: { - defaults+: { - [if 'custom' in parsed.customLib.fieldConfig.defaults then 'custom']: - parsed.customLib.fieldConfig.defaults.custom, - }, - }, - } - else {} - ); - - panel - + root.packageDocMixin(title, 'panel.') - + veneer.panel(title, panel), - }, - - rowPanelLib: { - new(dashboardSchema): - // Move rowPanel schema to panels - local schema = - root.restructure({ - info: { - title: 'RowPanelCfg', - }, - components: { - schemas: - dashboardSchema.components.schemas - { - RowPanelCfg: - dashboardSchema.components.schemas.RowPanel - { properties+: { - type: { const: 'row' }, - panels+: { items: {} }, - } }, - }, - }, - }); - - - local title = schema.info.title; - local render = crdsonnet.fromOpenAPI( - 'lib', - schema.components.schemas[title], - schema, - render='dynamic', - ); - if 'lib' in render - then - local panel = render.lib; - panel - + root.packageDocMixin(title, 'panel.') - + veneer.row('row', panel) - else {}, - }, -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/grid.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/util/grid.libsonnet deleted file mode 100644 index 6ee05ce..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/grid.libsonnet +++ /dev/null @@ -1,134 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - local root = self, - - local rowPanelHeight = 1, - local gridWidth = 24, - - // Calculates the number of rows for a set of panels. - countRows(panels, panelWidth): - std.ceil(std.length(panels) / std.floor(gridWidth / panelWidth)), - - // Calculates gridPos for a panel based on its index, width and height. - gridPosForIndex(index, panelWidth, panelHeight, startY): { - local panelsPerRow = std.floor(gridWidth / panelWidth), - local row = std.floor(index / panelsPerRow), - local col = std.mod(index, panelsPerRow), - gridPos: { - w: panelWidth, - h: panelHeight, - x: panelWidth * col, - y: startY + (panelHeight * row) + row, - }, - }, - - // Configures gridPos for each panel in a grid with equal width and equal height. - makePanelGrid(panels, panelWidth, panelHeight, startY): - std.mapWithIndex( - function(i, panel) - panel + root.gridPosForIndex(i, panelWidth, panelHeight, startY), - panels - ), - - '#makeGrid':: d.func.new( - ||| - `makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` - and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, - then all panels below it will be folded into the row. - - This function will use the full grid of 24 columns, setting `panelWidth` to a value - that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) - Other value for `panelWidth` will leave a gap on the far right. - |||, - args=[ - d.arg('panels', d.T.array), - d.arg('panelWidth', d.T.number), - d.arg('panelHeight', d.T.number), - ], - ), - makeGrid(panels, panelWidth=8, panelHeight=8): - // Get indexes for all Row panels - local rowIndexes = [ - i - for i in std.range(0, std.length(panels) - 1) - if panels[i].type == 'row' - ]; - - // Group panels below each Row panel - local rowGroups = - std.mapWithIndex( - function(i, r) { - header: - { - // Set initial values to ensure a value is set - // may be overridden at per Row panel - collapsed: false, - panels: [], - } - + panels[r], - panels: - self.header.panels // prepend panels that are part of the Row panel - + (if i == std.length(rowIndexes) - 1 // last rowIndex - then panels[r + 1:] - else panels[r + 1:rowIndexes[i + 1]]), - rows: root.countRows(self.panels, panelWidth), - }, - rowIndexes - ); - - // Loop over rowGroups - std.foldl( - function(acc, rowGroup) acc { - local y = acc.nexty, - nexty: y // previous y - + (rowGroup.rows * panelHeight) // height of all rows - + rowGroup.rows // plus 1 for each row - + acc.lastRowPanelHeight, - - lastRowPanelHeight: rowPanelHeight, // set height for next round - - // Create a grid per group - local panels = root.makePanelGrid(rowGroup.panels, panelWidth, panelHeight, y + 1), - - panels+: - [ - // Add row header aka the Row panel - rowGroup.header { - gridPos: { - w: gridWidth, // always full length - h: rowPanelHeight, // always 1 height - x: 0, // always at beginning - y: y, - }, - panels: - // If row is collapsed, then store panels inside Row panel - if rowGroup.header.collapsed - then panels - else [], - }, - ] - + ( - // If row is not collapsed, then expose panels directly - if !rowGroup.header.collapsed - then panels - else [] - ), - }, - rowGroups, - { - // Get panels that come before the rowGroups - local panelsBeforeRowGroups = - if std.length(rowIndexes) != 0 - then panels[0:rowIndexes[0]] - else panels, // matches all panels if no Row panels found - local rows = root.countRows(panelsBeforeRowGroups, panelWidth), - nexty: (rows * panelHeight) + rows, - - lastRowPanelHeight: 0, // starts without a row panel - - // Create a grid for the panels that come before the rowGroups - panels: root.makePanelGrid(panelsBeforeRowGroups, panelWidth, panelHeight, 0), - } - ).panels, -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/panel.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/util/panel.libsonnet deleted file mode 100644 index 55e0772..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/panel.libsonnet +++ /dev/null @@ -1,51 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - local this = self, - - '#setPanelIDs':: d.func.new( - ||| - `setPanelIDs` ensures that all `panels` have a unique ID, this functions is used in - `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent - experience. - - used in ../veneer/dashboard.libsonnet - |||, - args=[ - d.arg('panels', d.T.array), - ] - ), - setPanelIDs(panels): - local infunc(panels, start=1) = - std.foldl( - function(acc, panel) - acc { - index: // Track the index to ensure no duplicates exist. - acc.index - + 1 - + (if panel.type == 'row' - && 'panels' in panel - then std.length(panel.panels) - else 0), - - panels+: [ - panel { id: acc.index } - + ( - if panel.type == 'row' - && 'panels' in panel - then { - panels: - infunc( - panel.panels, - acc.index + 1 - ), - } - else {} - ), - ], - }, - panels, - { index: start, panels: [] } - ).panels; - infunc(panels), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/annotation.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/annotation.libsonnet deleted file mode 100644 index 697d2a9..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/annotation.libsonnet +++ /dev/null @@ -1,12 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -// The `anno` argument should match `dashboard.annotations.list` -function(anno) - anno { - '#':: d.package.newSub( - 'annotation', - '', - ), - - // TODO: provide API that matches the UI - } diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/core.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/core.libsonnet deleted file mode 100644 index f6dc89e..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/core.libsonnet +++ /dev/null @@ -1,313 +0,0 @@ -local util = import '../util/main.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -local veneer = { - dashboard+: { - // Remove legacy panels (heatmap, graph), new users should not create those. - // Schemas are also underdeveloped. - panels:: {}, - - '#new':: d.func.new( - 'Creates a new dashboard with a title.', - args=[d.arg('title', d.T.string)] - ), - new(title): - self.withTitle(title) - + self.withSchemaVersion() - + self.withTimezone('utc') - + self.time.withFrom('now-6h') - + self.time.withTo('now'), - - // Hide functions covered by objects - '#withTime':: {}, - '#withTimeMixin':: {}, - '#withTimepicker':: {}, - '#withTimepickerMixin':: {}, - '#withGraphTooltip':: {}, - '#withGraphTooltipMixin':: {}, - - // Hide internal values - '#withGnetId':: {}, - '#withId':: {}, - '#withRevision':: {}, - '#withVersion':: {}, - '#snapshot':: {}, // Snapshots can't be created through code afaik - '#withSnapshot':: {}, - '#withSnapshotMixin':: {}, - - - local withGraphTooltip = super.withGraphTooltip, - graphTooltip+: { - // 0 - Default - // 1 - Shared crosshair - // 2 - Shared tooltip - '#withSharedCrosshair':: d.func.new( - 'Share crosshair on all panels.', - ), - withSharedCrosshair(): - withGraphTooltip(1), - - '#withSharedTooltip':: d.func.new( - 'Share crosshair and tooltip on all panels.', - ), - withSharedTooltip(): - withGraphTooltip(2), - }, - - // Manual veneer for annotations - '#annotations':: {}, - annotation: (import './annotation.libsonnet')(self.annotations.list), - '#withAnnotations': - d.func.new( - ||| - `withAnnotations` adds an array of annotations to a dashboard. - - This function appends passed data to existing values - |||, - args=[d.arg('value', d.T.array)] - ), - withAnnotations(value): self.annotations.withList(value), - '#withAnnotationsMixin': - d.func.new( - ||| - `withAnnotationsMixin` adds an array of annotations to a dashboard. - - This function appends passed data to existing values - |||, - args=[d.arg('value', d.T.array)] - ), - withAnnotationsMixin(value): self.annotations.withListMixin(value), - - // Manual veneer for links (matches UI) - '#links':: {}, - link: (import './link.libsonnet')(self.links), - - // Manual veneer for variables (matches UI) - variable: (import './variable.libsonnet')(self.templating.list), - - '#withVariables': - d.func.new( - ||| - `withVariables` adds an array of variables to a dashboard - |||, - args=[d.arg('value', d.T.array)] - ), - withVariables(value): self.templating.withList(value), - - '#withVariablesMixin': - d.func.new( - ||| - `withVariablesMixin` adds an array of variables to a dashboard. - - This function appends passed data to existing values - |||, - args=[d.arg('value', d.T.array)] - ), - withVariablesMixin(value): self.templating.withListMixin(value), - - - // Hide from docs but keep available for backwards compatibility, use `variable` subpackage instead. - '#templateVariable':: {}, - templateVariable:: self.templating.list, - '#templating':: {}, - templating+: { - list+: { - local this = self, - - '#new':: d.func.new( - 'Create a template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('type', d.T.string, default='query'), - ] - ), - new(name, type='query'): - { - name: name, - type: type, - [if type == 'custom' then 'query']: '', - [if type == 'custom' then 'current']: - util.dashboard.getOptionsForCustomQuery(self.query).current, - [if type == 'custom' then 'options']: - util.dashboard.getOptionsForCustomQuery(self.query).options, - }, - - withType(value): - super.withType(value) - + { - [if value == 'custom' then 'query']: '', - [if value == 'custom' then 'current']: - util.dashboard.getOptionsForCustomQuery(self.query).current, - [if value == 'custom' then 'options']: - util.dashboard.getOptionsForCustomQuery(self.query).options, - }, - - query+: { - '#withLabelValues':: d.func.new( - 'Construct a Prometheus template variable using `label_values()`.', - args=[ - d.arg('label', d.T.string), - d.arg('metric', d.T.string), - ] - ), - withLabelValues(label, metric): { - query: 'label_values(%s, %s)' % [metric, label], - }, - }, - - '#withRegex':: d.func.new( - 'Filter the values with a regex.', - args=[ - d.arg('value', d.T.string), - ] - ), - withRegex(value): { - regex: value, - }, - - // Deliberately undocumented, use `refresh` below - withRefresh(value): { - // 1 - On dashboard load - // 2 - On time range chagne - refresh: value, - }, - - local withRefresh = self.withRefresh, - refresh+: { - '#onLoad':: d.func.new( - 'Refresh label values on dashboard load.' - ), - onLoad(): - withRefresh(1), - - '#onTime':: d.func.new( - 'Refresh label values on time range change.' - ), - onTime(): - withRefresh(2), - }, - - '#withMulti':: d.func.new( - 'Enable selecting multiple values.', - args=[ - d.arg('value', d.T.boolean, default=true), - ] - ), - withMulti(value=true): { - multi: value, - }, - - '#withIncludeAll':: d.func.new( - 'Provide option to select "All" values.', - args=[ - d.arg('value', d.T.boolean, default=true), - ] - ), - withIncludeAll(value=true): { - includeAll: value, - }, - - '#withAllValue':: d.func.new( - ||| - Provide value to use with the `withIncludeAll`, this will also enable - includeAll by default. - |||, - args=[ - d.arg('value', d.T.string), - ] - ), - withAllValue(value): - self.withIncludeAll(true) - + { - allValue: value, - }, - - - '#withSort':: d.func.new( - ||| - Choose how to sort the values in the dropdown. - - This can be called as `withSort() to use the integer values for each - option. If `i==0` then it will be ignored and the other arguments will take - precedence. - - The numerical values are: - - - 1 - Alphabetical (asc) - - 2 - Alphabetical (desc) - - 3 - Numerical (asc) - - 4 - Numerical (desc) - - 5 - Alphabetical (case-insensitive, asc) - - 6 - Alphabetical (case-insensitive, desc) - |||, - args=[ - d.arg('i', d.T.number, default=0), - d.arg('type', d.T.string, default='alphabetical'), - d.arg('asc', d.T.boolean, default=true), - d.arg('caseInsensitive', d.T.boolean, default=false), - ], - ), - withSort(i=0, type='alphabetical', asc=true, caseInsensitive=false): - if i != 0 // provide fallback to numerical value - then { sort: i } - else - { - local mapping = { - alphabethical: - if !caseInsensitive - then - if asc - then 1 - else 2 - else - if asc - then 5 - else 6, - numerical: - if asc - then 3 - else 4, - }, - sort: mapping[type], - }, - - datasource+: { - '#new':: d.func.new( - 'Select a datasource for the variable template query.', - args=[ - d.arg('type', d.T.string), - d.arg('uid', d.T.string), - ] - ), - new(type, uid): - self.withType(type) - + self.withUid(uid), - - '#fromVariable':: d.func.new( - 'Select the datasource from another template variable.', - args=[ - d.arg('variable', d.T.object), - ] - ), - fromVariable(variable): - if variable.type == 'datasource' - then - self.new(variable.query, '${%s}' % variable.name) - else - error "`variable` not of type 'datasource'", - }, - }, - }, - - withPanels(value): { - _panels:: if std.isArray(value) then value else [value], - panels: util.panel.setPanelIDs(self._panels), - }, - withPanelsMixin(value): { - _panels+:: if std.isArray(value) then value else [value], - panels: util.panel.setPanelIDs(self._panels), - }, - }, -}; - -function(name) std.get(veneer, name, default={}) diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/link.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/link.libsonnet deleted file mode 100644 index 20909bf..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/link.libsonnet +++ /dev/null @@ -1,65 +0,0 @@ -local helpers = import '../helpers.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -// The `link` argument should match `dashboard.links` -function(link) { - - '#':: d.package.newSub( - 'link', - '', - ), - - local groupings = { - options: [ - 'withAsDropdown', - 'withKeepTime', - 'withIncludeVars', - 'withTargetBlank', - ], - linkOptions: [ - 'withTooltip', - 'withIcon', - ], - }, - - local grouped = helpers.group(link, groupings), - - dashboards: - { - '#new':: d.func.new( - ||| - Create links to dashboards based on `tags`. - |||, - args=[ - d.arg('title', d.T.string), - d.arg('tags', d.T.array), - ] - ), - new(title, tags): - link.withTitle(title) - + link.withType('dashboards') - + link.withTags(tags), - - options: grouped.options, - }, - - link: - grouped.linkOptions { - '#new':: d.func.new( - ||| - Create link to an arbitrary URL. - |||, - args=[ - d.arg('title', d.T.string), - d.arg('url', d.T.string), - ] - ), - new(title, url): - link.withTitle(title) - + link.withType('link') - + link.withUrl(url), - - options: grouped.options, - }, - -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/main.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/main.libsonnet deleted file mode 100644 index 86e0008..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/main.libsonnet +++ /dev/null @@ -1,6 +0,0 @@ -{ - core: (import './core.libsonnet'), - panel: (import './panel.libsonnet'), - row: (import './row.libsonnet'), - query: (import './query.libsonnet'), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/panel.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/panel.libsonnet deleted file mode 100644 index 7cf1800..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/panel.libsonnet +++ /dev/null @@ -1,226 +0,0 @@ -local helpers = import '../helpers.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -local groupings = { - panelOptions: [ - 'withTitle', - 'withDescription', // both found in root and fieldConfig.defaults ??? - 'withTransparent', - 'withLinks', // depend on sub package - 'withLinksMixin', - 'withRepeat', // to veneer // missing maxPerRow - 'withRepeatDirection', - ], - - queryOptions: [ - 'withDatasource', // In as-code, default to per-query datasources - 'withDatasourceMixin', - 'withMaxDataPoints', - 'withInterval', //minInterval - //'queryCachingTTL', // not in schema - 'withTimeFrom', //relativeTime - 'withTimeShift', - //'hideTimeOverride', // not in schema - 'withTargets', // query, expression or recorded query, not clear from schema - 'withTargetsMixin', - 'withTransformations', // depend on very bare sub package for a very useful feature - 'withTransformationsMixin', - ], - - standardOptions: [ // 'fieldConfig.defaults. - 'fieldConfig.defaults.withUnit', - 'fieldConfig.defaults.withMin', - 'fieldConfig.defaults.withMax', - 'fieldConfig.defaults.withDecimals', - 'fieldConfig.defaults.withDisplayName', - 'fieldConfig.defaults.color', - 'fieldConfig.defaults.withNoValue', - 'fieldConfig.defaults.withLinks', // known as 'Data links' in UI, uses links subpackage - 'fieldConfig.defaults.withLinksMixin', - 'fieldConfig.defaults.withMappings', // known as 'Value mappings' in UI, uses valueMapping subpackage - 'fieldConfig.defaults.withMappingsMixin', - - // fieldOverrides needs to recieve more attention in Grafonnet, the JSON is unintuitive - // matcher = obj, properties = array, unclear in current grafonnet - 'fieldConfig.withOverrides', // known as 'Overrides' in UI, uses fieldOverrides subpackage - 'fieldConfig.withOverridesMixin', - ], - - 'standardOptions.thresholds': [ - 'fieldConfig.defaults.thresholds.withMode', - 'fieldConfig.defaults.thresholds.withSteps', - 'fieldConfig.defaults.thresholds.withStepsMixin', - ], -}; - -local subPackages = [ - { - from: 'links', - to: 'link', - docstring: '', - }, - { - from: 'transformations', - to: 'transformation', - docstring: '', - }, - { - from: 'fieldConfig.defaults.mappings', - to: 'valueMapping', - docstring: '', - }, - { - from: 'fieldConfig.defaults.thresholds.steps', - to: 'thresholdStep', - docstring: '', - }, -]; - -local toRemove = [ - // Access through more specific attributes - '#withFieldConfig', - '#withFieldConfigMixin', - '#withGridPos', - '#withGridPosMixin', - '#withOptions', - '#withOptionsMixin', - 'fieldConfig.#withDefaults', - 'fieldConfig.#withDefaultsMixin', - 'fieldConfig.defaults.#withColor', - 'fieldConfig.defaults.#withColorMixin', - 'fieldConfig.defaults.#withCustom', - 'fieldConfig.defaults.#withCustomMixin', - 'fieldConfig.defaults.#withThresholds', - 'fieldConfig.defaults.#withThresholdsMixin', - - // Internal - '#withId', - '#withPluginVersion', // The current PluginVersion value should come from the schema, this should be set on `new()`, 9.4/9.5 schema's don't have a value. - '#withRepeatPanelId', - '#withType', - - // Not in UI - '#withLibraryPanel', - '#withLibraryPanelMixin', - '#withTags', // seems to be related to search - '#withTagsMixin', - 'fieldConfig.defaults.#withDescription', - 'fieldConfig.defaults.#withDisplayNameFromDS', - 'fieldConfig.defaults.#withFilterable', // only found in overrides - 'fieldConfig.defaults.#withPath', // also related to overrides - 'fieldConfig.defaults.#withWriteable', - - // Old fields, not used anymore - '#withThresholds', - '#withThresholdsMixin', - '#withTimeRegions', - '#withTimeRegionsMixin', -]; - - -function(name, panel) - helpers.regroup(panel, groupings) - + helpers.repackage(panel, subPackages) - + helpers.removePaths(panel, toRemove) - + { - '#new':: d.func.new( - 'Creates a new %s panel with a title.' % name, - args=[d.arg('title', d.T.string)] - ), - new(title): - self.withTitle(title) - + self.withType() - // Default to Mixed datasource so panels can be datasource agnostic, this - // requires query targets to explicitly set datasource, which is a lot more - // interesting from a reusability standpoint. - + self.datasource.withType('datasource') - + self.datasource.withUid('-- Mixed --'), - - fieldConfig+: { - '#overrides':: {}, - overrides+:: {}, - }, - local overrides = super.fieldConfig.overrides, - fieldOverride: - local matchers = [ - 'byName', - 'byRegexp', - 'byType', - 'byQuery', - 'byValue', // TODO: byValue takes more complex `options` than string - ]; - { - '#':: d.package.newSub( - 'fieldOverride', - ||| - Overrides allow you to customize visualization settings for specific fields or - series. This is accomplished by adding an override rule that targets - a particular set of fields and that can each define multiple options. - - ```jsonnet - fieldOverride.byType.new('number') - + fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') - ) - ``` - ||| - ), - } + { - [matcher]: { - '#new':: d.fn( - '`new` creates a new override of type `%s`.' % matcher, - args=[ - d.arg('value', d.T.string), - ] - ), - new(value): - overrides.matcher.withId(matcher) - + overrides.matcher.withOptions(value), - - '#withProperty':: d.fn( - ||| - `withProperty` adds a property that needs to be overridden. This function can - be called multiple time, adding more properties. - |||, - args=[ - d.arg('id', d.T.string), - d.arg('value', d.T.any), - ] - ), - withProperty(id, value): - overrides.withPropertiesMixin([ - overrides.properties.withId(id) - + overrides.properties.withValue(value), - ]), - - '#withPropertiesFromOptions':: d.fn( - ||| - `withPropertiesFromOptions` takes an object with properties that need to be - overridden. See example code above. - |||, - args=[ - d.arg('options', d.T.object), - ] - ), - withPropertiesFromOptions(options): - local infunc(input, path=[]) = - std.foldl( - function(acc, p) - acc + ( - if std.isObject(input[p]) - then infunc(input[p], path=path + [p]) - else - overrides.withPropertiesMixin([ - overrides.properties.withId(std.join('.', path + [p])) - + overrides.properties.withValue(input[p]), - ]) - ), - std.objectFields(input), - {} - ); - infunc(options.fieldConfig.defaults), - } - for matcher in matchers - }, - } diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/query.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/query.libsonnet deleted file mode 100644 index b05163f..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/query.libsonnet +++ /dev/null @@ -1,90 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - - -// Upstream schema `DataQuery.datasource` is not properly defined, this bit of veneer -// provides a generic way for setting the datasource on a query type. -local datasourceFunction(type) = { - '#withDatasource':: d.func.new( - 'Set the datasource for this query.', - args=[ - d.arg('value', d.T.string), - ] - ), - withDatasource(value): { - datasource+: { - type: type, - uid: value, - }, - }, -}; -local veneer = { - loki+: - { - '#new':: d.func.new( - 'Creates a new loki query target for panels.', - args=[ - d.arg('datasource', d.T.string), - d.arg('expr', d.T.string), - ] - ), - new(datasource, expr): - self.withDatasource(datasource) - + self.withExpr(expr), - - } - + datasourceFunction('loki'), - - prometheus+: - { - '#new':: d.func.new( - 'Creates a new prometheus query target for panels.', - args=[ - d.arg('datasource', d.T.string), - d.arg('expr', d.T.string), - ] - ), - new(datasource, expr): - self.withDatasource(datasource) - + self.withExpr(expr), - - '#withIntervalFactor':: d.func.new( - 'Set the interval factor for this query.', - args=[ - d.arg('value', d.T.string), - ] - ), - withIntervalFactor(value): { - intervalFactor: value, - }, - - '#withLegendFormat':: d.func.new( - 'Set the legend format for this query.', - args=[ - d.arg('value', d.T.string), - ] - ), - withLegendFormat(value): { - legendFormat: value, - }, - } - + datasourceFunction('prometheus'), - - tempo+: - { - '#new':: d.func.new( - 'Creates a new tempo query target for panels.', - args=[ - d.arg('datasource', d.T.string), - d.arg('query', d.T.string), - d.arg('filters', d.T.array), - ] - ), - new(datasource, query, filters): - self.withDatasource(datasource) - + self.withQuery(query) - + self.withFilters(filters), - } - + datasourceFunction('tempo'), -}; - -function(name) std.get(veneer, name, default={}) diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/row.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/row.libsonnet deleted file mode 100644 index 83236d2..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/row.libsonnet +++ /dev/null @@ -1,12 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -function(name, panel) - { - '#new':: d.func.new( - 'Creates a new %s panel with a title.' % name, - args=[d.arg('title', d.T.string)] - ), - new(title): - self.withTitle(title) - + self.withType(), - } diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/variable.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/variable.libsonnet deleted file mode 100644 index 789485a..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/variable.libsonnet +++ /dev/null @@ -1,459 +0,0 @@ -local helpers = import '../helpers.libsonnet'; -local util = import '../util/main.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -// The `var` argument should match `dashboard.templating.list` -function(var) { - - '#':: d.package.newSub( - 'variable', - ||| - Example usage: - - ```jsonnet - local g = import 'g.libsonnet'; - local var = g.dashboard.variable; - - local customVar = - var.custom.new( - 'myOptions', - values=['a', 'b', 'c', 'd'], - ) - + var.custom.generalOptions.withDescription( - 'This is a variable for my custom options.' - ) - + var.custom.selectionOptions.withMulti(); - - local queryVar = - var.query.new('queryOptions') - + var.query.queryTypes.withLabelValues( - 'up', - 'instance', - ) - + var.query.withDatasource( - type='prometheus', - uid='mimir-prod', - ) - + var.query.selectionOptions.withIncludeAll(); - - - g.dashboard.new('my dashboard') - + g.dashboard.withVariables([ - customVar, - queryVar, - ]) - ``` - |||, - ), - - local groupings = { - generalOptions: [ - 'withName', - 'withLabel', - 'withDescription', - ], - }, - - local general = - helpers.group(var, groupings) - + { - generalOptions+: - { - showOnDashboard: { - '#withLabelAndValue':: d.func.new(''), - withLabelAndValue(): var.withHide(0), - '#withValueOnly':: d.func.new(''), - withValueOnly(): var.withHide(1), - '#withNothing':: d.func.new(''), - withNothing(): var.withHide(2), - }, - }, - }, - - local selectionOptions = - { - selectionOptions: - { - '#withMulti':: d.func.new( - 'Enable selecting multiple values.', - args=[ - d.arg('value', d.T.boolean, default=true), - ] - ), - withMulti(value=true): { - multi: value, - }, - - '#withIncludeAll':: d.func.new( - ||| - `withIncludeAll` enables an option to include all variables. - - Optionally you can set a `customAllValue`. - |||, - args=[ - d.arg('value', d.T.boolean, default=true), - d.arg('customAllValue', d.T.boolean, default=null), - ] - ), - withIncludeAll(value=true, customAllValue=null): { - includeAll: value, - [if customAllValue != null then 'allValue']: customAllValue, - }, - }, - }, - - query: - general - + selectionOptions - + { - '#new':: d.func.new( - ||| - Create a query template variable. - - `query` argument is optional, this can also be set with `query.queryTypes`. - |||, - args=[ - d.arg('name', d.T.string), - d.arg('query', d.T.string, default=''), - ] - ), - new(name, query=''): - var.withName(name) - + var.withType('query') - + var.withQuery(query), - - '#withDatasource':: d.func.new( - 'Select a datasource for the variable template query.', - args=[ - d.arg('type', d.T.string), - d.arg('uid', d.T.string), - ] - ), - withDatasource(type, uid): - var.datasource.withType(type) - + var.datasource.withUid(uid), - - '#withDatasourceFromVariable':: d.func.new( - 'Select the datasource from another template variable.', - args=[ - d.arg('variable', d.T.object), - ] - ), - withDatasourceFromVariable(variable): - if variable.type == 'datasource' - then self.withDatasource(variable.query, '${%s}' % variable.name) - else error "`variable` not of type 'datasource'", - - '#withRegex':: d.func.new( - ||| - `withRegex` can extract part of a series name or metric node segment. Named - capture groups can be used to separate the display text and value - ([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). - |||, - args=[ - d.arg('value', d.T.string), - ] - ), - withRegex(value): { - regex: value, - }, - - '#withSort':: d.func.new( - ||| - Choose how to sort the values in the dropdown. - - This can be called as `withSort() to use the integer values for each - option. If `i==0` then it will be ignored and the other arguments will take - precedence. - - The numerical values are: - - - 1 - Alphabetical (asc) - - 2 - Alphabetical (desc) - - 3 - Numerical (asc) - - 4 - Numerical (desc) - - 5 - Alphabetical (case-insensitive, asc) - - 6 - Alphabetical (case-insensitive, desc) - |||, - args=[ - d.arg('i', d.T.number, default=0), - d.arg('type', d.T.string, default='alphabetical'), - d.arg('asc', d.T.boolean, default=true), - d.arg('caseInsensitive', d.T.boolean, default=false), - ], - ), - withSort(i=0, type='alphabetical', asc=true, caseInsensitive=false): - if i != 0 // provide fallback to numerical value - then { sort: i } - else - { - local mapping = { - alphabetical: - if !caseInsensitive - then - if asc - then 1 - else 2 - else - if asc - then 5 - else 6, - numerical: - if asc - then 3 - else 4, - }, - sort: mapping[type], - }, - - // TODO: Expand with Query types to match GUI - queryTypes: { - '#withLabelValues':: d.func.new( - 'Construct a Prometheus template variable using `label_values()`.', - args=[ - d.arg('label', d.T.string), - d.arg('metric', d.T.string), - ] - ), - withLabelValues(label, metric): - var.withQuery('label_values(%s, %s)' % [metric, label]), - }, - - // Deliberately undocumented, use `refresh` below - withRefresh(value): { - // 1 - On dashboard load - // 2 - On time range chagne - refresh: value, - }, - - local withRefresh = self.withRefresh, - refresh+: { - '#onLoad':: d.func.new( - 'Refresh label values on dashboard load.' - ), - onLoad(): withRefresh(1), - - '#onTime':: d.func.new( - 'Refresh label values on time range change.' - ), - onTime(): withRefresh(2), - }, - }, - - custom: - general - + selectionOptions - + { - '#new':: d.func.new( - ||| - `new` creates a custom template variable. - - The `values` array accepts an object with key/value keys, if it's not an object - then it will be added as a string. - - Example: - ``` - [ - { key: 'mykey', value: 'myvalue' }, - 'myvalue', - 12, - ] - |||, - args=[ - d.arg('name', d.T.string), - d.arg('values', d.T.array), - ] - ), - new(name, values): - var.withName(name) - + var.withType('custom') - + { - // Make values array available in jsonnet - values:: [ - if !std.isObject(item) - then { - key: std.toString(item), - value: std.toString(item), - } - else item - for item in values - ], - - // Render query from values array - query: - std.join(',', [ - std.join(' : ', [item.key, item.value]) - for item in self.values - ]), - - // Set current/options - current: util.dashboard.getCurrentFromValues(self.values), - options: util.dashboard.getOptionsFromValues(self.values), - }, - - withQuery(query): { - values:: util.dashboard.parseCustomQuery(query), - query: query, - }, - }, - - textbox: - general - { - '#new':: d.func.new( - '`new` creates a textbox template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('default', d.T.string, default=''), - ] - ), - new(name, default=''): - var.withName(name) - + var.withType('textbox') - + { - local this = self, - default:: default, - query: self.default, - - // Set current/options - keyvaluedict:: [{ key: this.query, value: this.query }], - current: util.dashboard.getCurrentFromValues(self.keyvaluedict), - options: util.dashboard.getOptionsFromValues(self.keyvaluedict), - }, - }, - - constant: - general - { - '#new':: d.func.new( - '`new` creates a hidden constant template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('value', d.T.string), - ] - ), - new(name, value=''): - var.withName(name) - + var.withType('constant') - + var.withHide(2) - + var.withQuery(value), - }, - - datasource: - general - + selectionOptions - + { - '#new':: d.func.new( - '`new` creates a datasource template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('type', d.T.string), - ] - ), - new(name, type): - var.withName(name) - + var.withType('datasource') - + var.withQuery(type), - - '#withRegex':: d.func.new( - ||| - `withRegex` filter for which data source instances to choose from in the - variable value list. Example: `/^prod/` - |||, - args=[ - d.arg('value', d.T.string), - ] - ), - withRegex(value): { - regex: value, - }, - }, - - interval: - general - { - '#new':: d.func.new( - '`new` creates an interval template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('values', d.T.array), - ] - ), - new(name, values): - var.withName(name) - + var.withType('interval') - + { - // Make values array available in jsonnet - values:: values, - // Render query from values array - query: std.join(',', self.values), - - // Set current/options - keyvaluedict:: [ - { - key: item, - value: item, - } - for item in values - ], - current: util.dashboard.getCurrentFromValues(self.keyvaluedict), - options: util.dashboard.getOptionsFromValues(self.keyvaluedict), - }, - - - '#withAutoOption':: d.func.new( - ||| - `withAutoOption` adds an options to dynamically calculate interval by dividing - time range by the count specified. - - `minInterval' has to be either unit-less or end with one of the following units: - "y, M, w, d, h, m, s, ms". - |||, - args=[ - d.arg('count', d.T.number), - d.arg('minInterval', d.T.string), - ] - ), - withAutoOption(count=30, minInterval='10s'): { - auto: true, - auto_count: count, - auto_min: minInterval, - - // Add auto item to current/options - keyvaluedict:: - [{ key: 'auto', value: '$__auto_interval_' + self.name }] - + super.keyvaluedict, - }, - }, - - adhoc: - general - { - '#new':: d.func.new( - '`new` creates an adhoc template variable for datasource with `type` and `uid`.', - args=[ - d.arg('name', d.T.string), - d.arg('type', d.T.string), - d.arg('uid', d.T.string), - ] - ), - new(name, type, uid): - var.withName(name) - + var.withType('adhoc') - + var.datasource.withType(type) - + var.datasource.withUid(uid), - - '#newFromVariable':: d.func.new( - 'Same as `new` but selecting the datasource from another template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('variable', d.T.object), - ] - ), - newFromDatasourceVariable(name, variable): - if variable.type == 'datasource' - then self.new(name, variable.query, '${%s}' % variable.name) - else error "`variable` not of type 'datasource'", - - }, -} diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet deleted file mode 100644 index 0f496ab..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet +++ /dev/null @@ -1,50 +0,0 @@ -// Code generated - EDITING IS FUTILE. DO NOT EDIT. -// -// Generated by pipeline: -// jsonnet -// Using jennies: -// JsonnetImportsCoreJenny -// -// Run 'go generate ./' from repository root to regenerate. - -[ - import "./kinds/core/dashboard/x/dashboard_types_gen.json", - import "./kinds/core/librarypanel/x/librarypanel_types_gen.json", - import "./kinds/core/playlist/x/playlist_types_gen.json", - import "./kinds/core/preferences/x/preferences_types_gen.json", - import "./kinds/core/publicdashboard/x/publicdashboard_types_gen.json", - import "./kinds/core/serviceaccount/x/serviceaccount_types_gen.json", - import "./kinds/core/team/x/team_types_gen.json", - import "./kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json", - import "./kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json", - import "./kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json", - import "./kinds/composable/loki/dataquery/x/loki_types_gen.json", - import "./kinds/composable/parca/dataquery/x/parca_types_gen.json", - import "./kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json", - import "./kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json", - import "./kinds/composable/tempo/dataquery/x/tempo_types_gen.json", - import "./kinds/composable/testdata/dataquery/x/testdata_types_gen.json", - import "./kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json", - import "./kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json", - import "./kinds/composable/barchart/panelcfg/x/barchart_types_gen.json", - import "./kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json", - import "./kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json", - import "./kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json", - import "./kinds/composable/debug/panelcfg/x/debug_types_gen.json", - import "./kinds/composable/gauge/panelcfg/x/gauge_types_gen.json", - import "./kinds/composable/geomap/panelcfg/x/geomap_types_gen.json", - import "./kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json", - import "./kinds/composable/histogram/panelcfg/x/histogram_types_gen.json", - import "./kinds/composable/logs/panelcfg/x/logs_types_gen.json", - import "./kinds/composable/news/panelcfg/x/news_types_gen.json", - import "./kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json", - import "./kinds/composable/piechart/panelcfg/x/piechart_types_gen.json", - import "./kinds/composable/stat/panelcfg/x/stat_types_gen.json", - import "./kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json", - import "./kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json", - import "./kinds/composable/table/panelcfg/x/table_types_gen.json", - import "./kinds/composable/text/panelcfg/x/text_types_gen.json", - import "./kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json", - import "./kinds/composable/trend/panelcfg/x/trend_types_gen.json", - import "./kinds/composable/xychart/panelcfg/x/xychart_types_gen.json", -] diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json deleted file mode 100644 index 68322af..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "AlertGroupsPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AlertGroupsPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "labels", - "alertmanager", - "expandAll" - ], - "properties": { - "labels": { - "description": "Comma-separated list of values used to filter alert results", - "type": "string" - }, - "alertmanager": { - "description": "Name of the alertmanager used as a source for alerts", - "type": "string" - }, - "expandAll": { - "description": "Expand all alert groups by default", - "type": "boolean" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json deleted file mode 100644 index de266cf..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "AnnotationsListPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AnnotationsListPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "onlyFromThisDashboard", - "onlyInTimeRange", - "tags", - "limit", - "showUser", - "showTime", - "showTags", - "navigateToPanel", - "navigateBefore", - "navigateAfter" - ], - "properties": { - "onlyFromThisDashboard": { - "type": "boolean", - "default": false - }, - "onlyInTimeRange": { - "type": "boolean", - "default": false - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "limit": { - "type": "integer", - "minimum": 0, - "maximum": 4294967295, - "default": 10 - }, - "showUser": { - "type": "boolean", - "default": true - }, - "showTime": { - "type": "boolean", - "default": true - }, - "showTags": { - "type": "boolean", - "default": true - }, - "navigateToPanel": { - "type": "boolean", - "default": true - }, - "navigateBefore": { - "type": "string", - "default": "10m" - }, - "navigateAfter": { - "type": "string", - "default": "10m" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json deleted file mode 100644 index 7ff584c..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json +++ /dev/null @@ -1,711 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "AzureMonitorDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AppInsightsGroupByQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "AppInsightsGroupByQuery" - ] - }, - "metricName": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "metricName" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AppInsightsMetricNameQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "AppInsightsMetricNameQuery" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureLogsQuery": { - "description": "Azure Monitor Logs sub-query properties", - "type": "object", - "properties": { - "query": { - "description": "KQL query to be executed.", - "type": "string" - }, - "resultFormat": { - "$ref": "#/components/schemas/ResultFormat" - }, - "resources": { - "description": "Array of resource URIs to be queried.", - "type": "array", - "items": { - "type": "string" - } - }, - "workspace": { - "description": "Workspace ID. This was removed in Grafana 8, but remains for backwards compat", - "type": "string" - }, - "resource": { - "description": "@deprecated Use resources instead", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMetricDimension": { - "type": "object", - "properties": { - "dimension": { - "description": "Name of Dimension to be filtered on.", - "type": "string" - }, - "operator": { - "description": "String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators.", - "type": "string" - }, - "filters": { - "description": "Values to match with the filter.", - "type": "array", - "items": { - "type": "string" - } - }, - "filter": { - "description": "@deprecated filter is deprecated in favour of filters to support multiselect.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMetricQuery": { - "type": "object", - "properties": { - "resources": { - "description": "Array of resource URIs to be queried.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AzureMonitorResource" - } - }, - "metricNamespace": { - "description": "metricNamespace is used as the resource type (or resource namespace).\nIt's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts\nKept the name of the variable as metricNamespace to avoid backward incompatibility issues.", - "type": "string" - }, - "customNamespace": { - "description": "Used as the value for the metricNamespace property when it's different from the resource namespace.", - "type": "string" - }, - "metricName": { - "description": "The metric to query data for within the specified metricNamespace. e.g. UsedCapacity", - "type": "string" - }, - "region": { - "description": "The Azure region containing the resource(s).", - "type": "string" - }, - "timeGrain": { - "description": "The granularity of data points to be queried. Defaults to auto.", - "type": "string" - }, - "aggregation": { - "description": "The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric.", - "type": "string" - }, - "dimensionFilters": { - "description": "Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AzureMetricDimension" - } - }, - "top": { - "description": "Maximum number of records to return. Defaults to 10.", - "type": "string" - }, - "allowedTimeGrainsMs": { - "description": "Time grains that are supported by the metric.", - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "alias": { - "description": "Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail.", - "type": "string" - }, - "timeGrainUnit": { - "description": "@deprecated", - "type": "string" - }, - "dimension": { - "description": "@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration", - "type": "string" - }, - "dimensionFilter": { - "description": "@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration", - "type": "string" - }, - "metricDefinition": { - "description": "@deprecated Use metricNamespace instead", - "type": "string" - }, - "resourceUri": { - "description": "@deprecated Use resourceGroup, resourceName and metricNamespace instead", - "type": "string" - }, - "resourceGroup": { - "description": "@deprecated Use resources instead", - "type": "string" - }, - "resourceName": { - "description": "@deprecated Use resources instead", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMonitorDataQuery": { - "type": "object", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMonitorQuery": { - "type": "object", - "properties": { - "subscription": { - "description": "Azure subscription containing the resource(s) to be queried.", - "type": "string" - }, - "subscriptions": { - "description": "Subscriptions to be queried via Azure Resource Graph.", - "type": "array", - "items": { - "type": "string" - } - }, - "azureMonitor": { - "$ref": "#/components/schemas/AzureMetricQuery" - }, - "azureLogAnalytics": { - "$ref": "#/components/schemas/AzureLogsQuery" - }, - "azureResourceGraph": { - "$ref": "#/components/schemas/AzureResourceGraphQuery" - }, - "azureTraces": { - "$ref": "#/components/schemas/AzureTracesQuery" - }, - "grafanaTemplateVariableFn": { - "$ref": "#/components/schemas/GrafanaTemplateVariableQuery" - }, - "resourceGroup": { - "description": "Template variables params. These exist for backwards compatiblity with legacy template variables.", - "type": "string" - }, - "namespace": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "region": { - "description": "Azure Monitor query type.\nqueryType: #AzureQueryType", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMonitorResource": { - "type": "object", - "properties": { - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "resourceName": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - }, - "region": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureQueryType": { - "description": "Defines the supported queryTypes. GrafanaTemplateVariableFn is deprecated", - "type": "string", - "enum": [ - "Azure Monitor", - "Azure Log Analytics", - "Azure Resource Graph", - "Azure Traces", - "Azure Subscriptions", - "Azure Resource Groups", - "Azure Namespaces", - "Azure Resource Names", - "Azure Metric Names", - "Azure Workspaces", - "Azure Regions", - "Grafana Template Variable Function" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureResourceGraphQuery": { - "type": "object", - "properties": { - "query": { - "description": "Azure Resource Graph KQL query to be executed.", - "type": "string" - }, - "resultFormat": { - "description": "Specifies the format results should be returned as. Defaults to table.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureTracesFilter": { - "type": "object", - "required": [ - "property", - "operation", - "filters" - ], - "properties": { - "property": { - "description": "Property name, auto-populated based on available traces.", - "type": "string" - }, - "operation": { - "description": "Comparison operator to use. Either equals or not equals.", - "type": "string" - }, - "filters": { - "description": "Values to filter by.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureTracesQuery": { - "description": "Application Insights Traces sub-query properties", - "type": "object", - "properties": { - "resultFormat": { - "$ref": "#/components/schemas/ResultFormat" - }, - "resources": { - "description": "Array of resource URIs to be queried.", - "type": "array", - "items": { - "type": "string" - } - }, - "operationId": { - "description": "Operation ID. Used only for Traces queries.", - "type": "string" - }, - "traceTypes": { - "description": "Types of events to filter by.", - "type": "array", - "items": { - "type": "string" - } - }, - "filters": { - "description": "Filters for property values.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AzureTracesFilter" - } - }, - "query": { - "description": "KQL query to be executed.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseGrafanaTemplateVariableQuery": { - "type": "object", - "properties": { - "rawQuery": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GrafanaTemplateVariableQuery": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/AppInsightsMetricNameQuery" - }, - { - "$ref": "#/components/schemas/AppInsightsGroupByQuery" - }, - { - "$ref": "#/components/schemas/SubscriptionsQuery" - }, - { - "$ref": "#/components/schemas/ResourceGroupsQuery" - }, - { - "$ref": "#/components/schemas/ResourceNamesQuery" - }, - { - "$ref": "#/components/schemas/MetricNamespaceQuery" - }, - { - "$ref": "#/components/schemas/MetricDefinitionsQuery" - }, - { - "$ref": "#/components/schemas/MetricNamesQuery" - }, - { - "$ref": "#/components/schemas/WorkspacesQuery" - }, - { - "$ref": "#/components/schemas/UnknownQuery" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GrafanaTemplateVariableQueryType": { - "type": "string", - "enum": [ - "AppInsightsMetricNameQuery", - "AppInsightsGroupByQuery", - "SubscriptionsQuery", - "ResourceGroupsQuery", - "ResourceNamesQuery", - "MetricNamespaceQuery", - "MetricNamesQuery", - "WorkspacesQuery", - "UnknownQuery" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricDefinitionsQuery": { - "description": "@deprecated Use MetricNamespaceQuery instead", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "MetricDefinitionsQuery" - ] - }, - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - }, - "resourceName": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription", - "resourceGroup" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricNamesQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "MetricNamesQuery" - ] - }, - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "resourceName": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription", - "resourceGroup", - "resourceName", - "metricNamespace" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricNamespaceQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "MetricNamespaceQuery" - ] - }, - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - }, - "resourceName": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription", - "resourceGroup" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ResourceGroupsQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "ResourceGroupsQuery" - ] - }, - "subscription": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ResourceNamesQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "ResourceNamesQuery" - ] - }, - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription", - "resourceGroup", - "metricNamespace" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ResultFormat": { - "type": "string", - "enum": [ - "table", - "time_series", - "trace" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SubscriptionsQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "SubscriptionsQuery" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "UnknownQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "UnknownQuery" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "WorkspacesQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "WorkspacesQuery" - ] - }, - "subscription": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/barchart/panelcfg/x/barchart_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/barchart/panelcfg/x/barchart_types_gen.json deleted file mode 100644 index 5882a45..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/barchart/panelcfg/x/barchart_types_gen.json +++ /dev/null @@ -1,505 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "BarChartPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarChartPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "xField": { - "description": "Manually select which field from the dataset to represent the x field.", - "type": "string" - }, - "colorByField": { - "description": "Use the color value for a sibling field to color each bar value.", - "type": "string" - }, - "orientation": { - "description": "Controls the orientation of the bar chart, either vertical or horizontal.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VizOrientation" - } - ] - }, - "barRadius": { - "description": "Controls the radius of each bar.", - "type": "number", - "minimum": 0, - "maximum": 0.5, - "default": 0 - }, - "xTickLabelRotation": { - "description": "Controls the rotation of the x axis labels.", - "type": "integer", - "minimum": -90, - "maximum": 90, - "default": 0 - }, - "xTickLabelMaxLength": { - "description": "Sets the max length that a label can have before it is truncated.", - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "xTickLabelSpacing": { - "description": "Controls the spacing between x axis labels.\nnegative values indicate backwards skipping behavior", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647, - "default": 0 - }, - "stacking": { - "description": "Controls whether bars are stacked or not, either normally or in percent mode.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/StackingMode" - } - ] - }, - "showValue": { - "description": "This controls whether values are shown on top or to the left of bars.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VisibilityMode" - } - ] - }, - "barWidth": { - "description": "Controls the width of bars. 1 = Max width, 0 = Min width.", - "type": "number", - "minimum": 0, - "maximum": 1, - "default": 0.97 - }, - "groupWidth": { - "description": "Controls the width of groups. 1 = max with, 0 = min width.", - "type": "number", - "minimum": 0, - "maximum": 1, - "default": 0.7 - }, - "fullHighlight": { - "description": "Enables mode which highlights the entire bar area and shows tooltip when cursor\nhovers over highlighted area", - "type": "boolean", - "default": false - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "orientation", - "xTickLabelRotation", - "xTickLabelMaxLength", - "stacking", - "showValue", - "barWidth", - "groupWidth", - "fullHighlight" - ] - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "lineWidth": { - "description": "Controls line width of the bars.", - "type": "integer", - "minimum": 0, - "maximum": 10, - "default": 1 - }, - "fillOpacity": { - "description": "Controls the fill opacity of the bars.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "default": 80 - }, - "gradientMode": { - "description": "Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.\nGradient appearance is influenced by the Fill opacity setting.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/GraphGradientMode" - } - ] - }, - "thresholdsStyle": { - "$ref": "#/components/schemas/GraphThresholdsStyleConfig" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AxisConfig" - }, - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphGradientMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "opacity", - "hue", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphThresholdsStyleConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/GraphTresholdsStyleMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTresholdsStyleMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "off", - "line", - "dashed", - "area", - "line+area", - "dashed+area", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "normal", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json deleted file mode 100644 index 143b0cd..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json +++ /dev/null @@ -1,172 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "BarGaugePanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "BarGaugeDisplayMode": { - "description": "Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI", - "type": "string", - "enum": [ - "basic", - "lcd", - "gradient" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarGaugePanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "displayMode": { - "type": "string", - "$ref": "#/components/schemas/BarGaugeDisplayMode" - }, - "valueMode": { - "type": "string", - "$ref": "#/components/schemas/BarGaugeValueMode" - }, - "showUnfilled": { - "type": "boolean", - "default": true - }, - "minVizWidth": { - "type": "integer", - "minimum": 0, - "maximum": 4294967295, - "default": 0 - }, - "minVizHeight": { - "type": "integer", - "minimum": 0, - "maximum": 4294967295, - "default": 10 - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/SingleStatBaseOptions" - }, - { - "required": [ - "displayMode", - "valueMode", - "showUnfilled", - "minVizWidth", - "minVizHeight" - ] - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarGaugeValueMode": { - "description": "Allows for the table cell gauge display type to set the gauge mode.", - "type": "string", - "enum": [ - "color", - "text", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ReduceDataOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "calcs" - ], - "properties": { - "values": { - "description": "If true show each row value", - "type": "boolean" - }, - "limit": { - "description": "if showing all values limit", - "type": "number" - }, - "calcs": { - "description": "When !values, pick one value for the whole field", - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "description": "Which fields to show. By default this is only numeric fields", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SingleStatBaseOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "reduceOptions": { - "$ref": "#/components/schemas/ReduceDataOptions" - }, - "orientation": { - "$ref": "#/components/schemas/VizOrientation" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "reduceOptions", - "orientation" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json deleted file mode 100644 index 04431a5..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json +++ /dev/null @@ -1,632 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "CloudWatchDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "CloudWatchAnnotationQuery": { - "description": "Shape of a CloudWatch Annotation query", - "type": "object", - "properties": { - "queryMode": { - "$ref": "#/components/schemas/CloudWatchQueryMode" - }, - "prefixMatching": { - "description": "Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix", - "type": "boolean" - }, - "actionPrefix": { - "description": "Use this parameter to filter the results of the operation to only those alarms\nthat use a certain alarm action. For example, you could specify the ARN of\nan SNS topic to find all alarms that send notifications to that topic.\ne.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action`\nbut not match `arn:aws:sns:us-east-1:123456789012:your-app-action`", - "type": "string" - }, - "alarmNamePrefix": { - "description": "An alarm name prefix. If you specify this parameter, you receive information\nabout all alarms that have names that start with this prefix.\ne.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu`", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "$ref": "#/components/schemas/MetricStat" - }, - { - "required": [ - "queryMode" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CloudWatchDataQuery": { - "type": "object", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CloudWatchLogsQuery": { - "description": "Shape of a CloudWatch Logs query", - "type": "object", - "properties": { - "queryMode": { - "$ref": "#/components/schemas/CloudWatchQueryMode" - }, - "id": { - "type": "string" - }, - "region": { - "description": "AWS region to query for the logs", - "type": "string" - }, - "expression": { - "description": "The CloudWatch Logs Insights query to execute", - "type": "string" - }, - "statsGroups": { - "description": "Fields to group the results by, this field is automatically populated whenever the query is updated", - "type": "array", - "items": { - "type": "string" - } - }, - "logGroups": { - "description": "Log groups to query", - "type": "array", - "items": { - "$ref": "#/components/schemas/LogGroup" - } - }, - "logGroupNames": { - "description": "@deprecated use logGroups", - "type": "array", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "queryMode", - "id", - "region" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CloudWatchMetricsQuery": { - "description": "Shape of a CloudWatch Metrics query", - "type": "object", - "properties": { - "queryMode": { - "$ref": "#/components/schemas/CloudWatchQueryMode" - }, - "metricQueryType": { - "$ref": "#/components/schemas/MetricQueryType" - }, - "metricEditorMode": { - "$ref": "#/components/schemas/MetricEditorMode" - }, - "id": { - "description": "ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.", - "type": "string" - }, - "alias": { - "description": "Deprecated: use label\n@deprecated use label", - "type": "string" - }, - "label": { - "description": "Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.", - "type": "string" - }, - "expression": { - "description": "Math expression query", - "type": "string" - }, - "sqlExpression": { - "description": "When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string.", - "type": "string" - }, - "sql": { - "$ref": "#/components/schemas/SQLExpression" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "$ref": "#/components/schemas/MetricStat" - }, - { - "required": [ - "id" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CloudWatchQueryMode": { - "type": "string", - "enum": [ - "Metrics", - "Logs", - "Annotations" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Dimensions": { - "description": "A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.", - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LogGroup": { - "type": "object", - "required": [ - "arn", - "name" - ], - "properties": { - "arn": { - "description": "ARN of the log group", - "type": "string" - }, - "name": { - "description": "Name of the log group", - "type": "string" - }, - "accountId": { - "description": "AccountId of the log group", - "type": "string" - }, - "accountLabel": { - "description": "Label of the log group", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricEditorMode": { - "type": "integer", - "enum": [ - 0, - 1 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricQueryType": { - "type": "integer", - "enum": [ - 0, - 1 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricStat": { - "type": "object", - "required": [ - "region", - "namespace" - ], - "properties": { - "region": { - "description": "AWS region to query for the metric", - "type": "string" - }, - "namespace": { - "description": "A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.", - "type": "string" - }, - "metricName": { - "description": "Name of the metric", - "type": "string" - }, - "dimensions": { - "$ref": "#/components/schemas/Dimensions" - }, - "matchExact": { - "description": "Only show metrics that exactly match all defined dimension names.", - "type": "boolean" - }, - "period": { - "description": "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes", - "type": "string" - }, - "accountId": { - "description": "The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.", - "type": "string" - }, - "statistic": { - "description": "Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.", - "type": "string" - }, - "statistics": { - "description": "@deprecated use statistic", - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorArrayExpression": { - "type": "object", - "required": [ - "type", - "expressions" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "and", - "or" - ] - }, - "expressions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryEditorExpression" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorExpression": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/QueryEditorArrayExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorPropertyExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorGroupByExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorFunctionExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorFunctionParameterExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorOperatorExpression" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorExpressionType": { - "type": "string", - "enum": [ - "property", - "operator", - "or", - "and", - "groupBy", - "function", - "functionParameter" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorFunctionExpression": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "function" - ] - } - ] - }, - "name": { - "type": "string" - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryEditorFunctionParameterExpression" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorFunctionParameterExpression": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "functionParameter" - ] - } - ] - }, - "name": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorGroupByExpression": { - "type": "object", - "required": [ - "type", - "property" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "groupBy" - ] - } - ] - }, - "property": { - "$ref": "#/components/schemas/QueryEditorProperty" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorOperator": { - "description": "TS type is QueryEditorOperator\u003cT extends QueryEditorOperatorValueType\u003e, extended in veneer", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "boolean" - }, - { - "type": "number", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807 - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryEditorOperatorType" - } - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorOperatorExpression": { - "type": "object", - "required": [ - "type", - "property", - "operator" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "operator" - ] - } - ] - }, - "property": { - "$ref": "#/components/schemas/QueryEditorProperty" - }, - "operator": { - "$ref": "#/components/schemas/QueryEditorOperator" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorOperatorType": { - "oneOf": [ - { - "type": "string", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "boolean", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "number", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "$schema": "http://json-schema.org/draft-04/schema#" - } - ] - }, - "QueryEditorOperatorValueType": { - "oneOf": [ - { - "type": "string", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "boolean", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "number", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryEditorOperatorType" - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - ] - }, - "QueryEditorProperty": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/QueryEditorPropertyType" - }, - "name": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorPropertyExpression": { - "type": "object", - "required": [ - "type", - "property" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "property" - ] - } - ] - }, - "property": { - "$ref": "#/components/schemas/QueryEditorProperty" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorPropertyType": { - "type": "string", - "enum": [ - "string" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SQLExpression": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/QueryEditorFunctionExpression" - }, - "from": { - "description": "FROM part of the SQL expression", - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/QueryEditorPropertyExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorFunctionExpression" - } - ] - }, - "where": { - "$ref": "#/components/schemas/QueryEditorArrayExpression" - }, - "groupBy": { - "$ref": "#/components/schemas/QueryEditorArrayExpression" - }, - "orderBy": { - "$ref": "#/components/schemas/QueryEditorFunctionExpression" - }, - "orderByDirection": { - "description": "The sort order of the SQL expression, `ASC` or `DESC`", - "type": "string" - }, - "limit": { - "description": "LIMIT part of the SQL expression", - "type": "integer", - "format": "int64" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json deleted file mode 100644 index 307b5fc..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "DashboardListPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DashboardListPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "keepTime", - "includeVars", - "showStarred", - "showRecentlyViewed", - "showSearch", - "showHeadings", - "maxItems", - "query", - "tags" - ], - "properties": { - "keepTime": { - "type": "boolean", - "default": false - }, - "includeVars": { - "type": "boolean", - "default": false - }, - "showStarred": { - "type": "boolean", - "default": true - }, - "showRecentlyViewed": { - "type": "boolean", - "default": false - }, - "showSearch": { - "type": "boolean", - "default": false - }, - "showHeadings": { - "type": "boolean", - "default": true - }, - "maxItems": { - "type": "integer", - "default": 10 - }, - "query": { - "type": "string", - "default": "" - }, - "folderId": { - "type": "integer" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json deleted file mode 100644 index 0bef3c8..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "DatagridPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DatagridPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "selectedSeries" - ], - "properties": { - "selectedSeries": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647, - "default": 0 - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/debug/panelcfg/x/debug_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/debug/panelcfg/x/debug_types_gen.json deleted file mode 100644 index 5b8813c..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/debug/panelcfg/x/debug_types_gen.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "DebugPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DebugMode": { - "type": "string", - "enum": [ - "render", - "events", - "cursor", - "State", - "ThrowError" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DebugPanelCfg": { - "type": "object", - "required": [ - "UpdateConfig", - "DebugMode", - "PanelOptions" - ], - "properties": { - "UpdateConfig": { - "type": "object", - "required": [ - "render", - "dataChanged", - "schemaChanged" - ], - "properties": { - "render": { - "type": "boolean" - }, - "dataChanged": { - "type": "boolean" - }, - "schemaChanged": { - "type": "boolean" - } - } - }, - "DebugMode": { - "type": "string", - "enum": [ - "render", - "events", - "cursor", - "State", - "ThrowError" - ] - }, - "PanelOptions": { - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/DebugMode" - }, - "counters": { - "$ref": "#/components/schemas/UpdateConfig" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "UpdateConfig": { - "type": "object", - "required": [ - "render", - "dataChanged", - "schemaChanged" - ], - "properties": { - "render": { - "type": "boolean" - }, - "dataChanged": { - "type": "boolean" - }, - "schemaChanged": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json deleted file mode 100644 index fb898e7..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json +++ /dev/null @@ -1,1756 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "ElasticsearchDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "Average": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "avg" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithMissingSupport" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseBucketAggregation": { - "type": "object", - "required": [ - "id", - "type" - ], - "properties": { - "id": { - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/BucketAggregationType" - }, - "settings": {} - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseMetricAggregation": { - "type": "object", - "required": [ - "type", - "id" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/MetricAggregationType" - }, - "id": { - "type": "string" - }, - "hide": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseMovingAverageModelSettings": { - "type": "object", - "required": [ - "model", - "window", - "predict" - ], - "properties": { - "model": { - "$ref": "#/components/schemas/MovingAverageModel" - }, - "window": { - "type": "string" - }, - "predict": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BasePipelineMetricAggregation": { - "type": "object", - "properties": { - "pipelineAgg": { - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BucketAggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/DateHistogram" - }, - { - "$ref": "#/components/schemas/Histogram" - }, - { - "$ref": "#/components/schemas/Terms" - }, - { - "$ref": "#/components/schemas/Filters" - }, - { - "$ref": "#/components/schemas/GeoHashGrid" - }, - { - "$ref": "#/components/schemas/Nested" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BucketAggregationType": { - "type": "string", - "enum": [ - "terms", - "filters", - "geohash_grid", - "date_histogram", - "histogram", - "nested" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BucketAggregationWithField": { - "type": "object", - "properties": { - "field": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseBucketAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BucketScript": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "bucket_script" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationWithMultipleBucketPaths" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Count": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "count" - ] - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CumulativeSum": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "cumulative_sum" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "format": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DateHistogram": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "date_histogram" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/DateHistogramSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DateHistogramSettings": { - "type": "object", - "properties": { - "interval": { - "type": "string" - }, - "min_doc_count": { - "type": "string" - }, - "trimEdges": { - "type": "string" - }, - "offset": { - "type": "string" - }, - "timeZone": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Derivative": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "derivative" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "unit": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ElasticsearchDataQuery": { - "type": "object", - "properties": { - "alias": { - "description": "Alias pattern", - "type": "string" - }, - "query": { - "description": "Lucene query", - "type": "string" - }, - "timeField": { - "description": "Name of time field", - "type": "string" - }, - "bucketAggs": { - "description": "List of bucket aggregations", - "type": "array", - "items": { - "$ref": "#/components/schemas/BucketAggregation" - } - }, - "metrics": { - "description": "List of metric aggregations", - "type": "array", - "items": { - "$ref": "#/components/schemas/MetricAggregation" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ExtendedStat": { - "type": "object", - "required": [ - "label", - "value" - ], - "properties": { - "label": { - "type": "string" - }, - "value": { - "$ref": "#/components/schemas/ExtendedStatMetaType" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ExtendedStatMetaType": { - "type": "string", - "enum": [ - "avg", - "min", - "max", - "sum", - "count", - "std_deviation", - "std_deviation_bounds_upper", - "std_deviation_bounds_lower" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ExtendedStats": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "extended_stats" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - }, - "sigma": { - "type": "string" - } - } - }, - "meta": { - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Filter": { - "type": "object", - "required": [ - "query", - "label" - ], - "properties": { - "query": { - "type": "string" - }, - "label": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Filters": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "filters" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/FiltersSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseBucketAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FiltersSettings": { - "type": "object", - "properties": { - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Filter" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GeoHashGrid": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "geohash_grid" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/GeoHashGridSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GeoHashGridSettings": { - "type": "object", - "properties": { - "precision": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Histogram": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "histogram" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/HistogramSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HistogramSettings": { - "type": "object", - "properties": { - "interval": { - "type": "string" - }, - "min_doc_count": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "InlineScript": { - "oneOf": [ - { - "type": "string", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "object", - "properties": { - "inline": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - ] - }, - "Logs": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "logs" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "limit": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Max": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "max" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/Count" - }, - { - "$ref": "#/components/schemas/PipelineMetricAggregation" - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithSettings" - }, - { - "not": { - "anyOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregation" - } - ] - } - } - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationType": { - "type": "string", - "enum": [ - "count", - "avg", - "sum", - "min", - "max", - "extended_stats", - "percentiles", - "cardinality", - "raw_document", - "raw_data", - "logs", - "rate", - "top_metrics", - "moving_avg", - "moving_fn", - "derivative", - "serial_diff", - "cumulative_sum", - "bucket_script" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationWithField": { - "type": "object", - "properties": { - "field": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationWithInlineScript": { - "type": "object", - "properties": { - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationWithMissingSupport": { - "type": "object", - "properties": { - "settings": { - "type": "object", - "properties": { - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationWithSettings": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/BucketScript" - }, - { - "$ref": "#/components/schemas/CumulativeSum" - }, - { - "$ref": "#/components/schemas/Derivative" - }, - { - "$ref": "#/components/schemas/SerialDiff" - }, - { - "$ref": "#/components/schemas/RawData" - }, - { - "$ref": "#/components/schemas/RawDocument" - }, - { - "$ref": "#/components/schemas/UniqueCount" - }, - { - "$ref": "#/components/schemas/Percentiles" - }, - { - "$ref": "#/components/schemas/ExtendedStats" - }, - { - "$ref": "#/components/schemas/Min" - }, - { - "$ref": "#/components/schemas/Max" - }, - { - "$ref": "#/components/schemas/Sum" - }, - { - "$ref": "#/components/schemas/Average" - }, - { - "$ref": "#/components/schemas/MovingAverage" - }, - { - "$ref": "#/components/schemas/MovingFunction" - }, - { - "$ref": "#/components/schemas/Logs" - }, - { - "$ref": "#/components/schemas/Rate" - }, - { - "$ref": "#/components/schemas/TopMetrics" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Min": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "min" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverage": { - "description": "#MovingAverage's settings are overridden in types.ts", - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "moving_avg" - ] - } - ] - }, - "settings": { - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageEWMAModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "ewma" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "alpha": { - "type": "string" - } - } - }, - "minimize": { - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model", - "minimize" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageHoltModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "holt" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "alpha": { - "type": "string" - }, - "beta": { - "type": "string" - } - } - }, - "minimize": { - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model", - "settings", - "minimize" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageHoltWintersModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "holt_winters" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "alpha": { - "type": "string" - }, - "beta": { - "type": "string" - }, - "gamma": { - "type": "string" - }, - "period": { - "type": "string" - }, - "pad": { - "type": "boolean" - } - } - }, - "minimize": { - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model", - "settings", - "minimize" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageLinearModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "linear" - ] - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageModel": { - "type": "string", - "enum": [ - "simple", - "linear", - "ewma", - "holt", - "holt_winters" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageModelOption": { - "type": "object", - "required": [ - "label", - "value" - ], - "properties": { - "label": { - "type": "string" - }, - "value": { - "$ref": "#/components/schemas/MovingAverageModel" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageSimpleModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "simple" - ] - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingFunction": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "moving_fn" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "window": { - "type": "string" - }, - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "shift": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Nested": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "nested" - ] - } - ] - }, - "settings": { - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Percentiles": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "percentiles" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - }, - "percents": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PipelineMetricAggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/MovingAverage" - }, - { - "$ref": "#/components/schemas/Derivative" - }, - { - "$ref": "#/components/schemas/CumulativeSum" - }, - { - "$ref": "#/components/schemas/BucketScript" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PipelineMetricAggregationType": { - "type": "string", - "enum": [ - "moving_avg", - "moving_fn", - "derivative", - "serial_diff", - "cumulative_sum", - "bucket_script" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PipelineMetricAggregationWithMultipleBucketPaths": { - "type": "object", - "properties": { - "pipelineVariables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PipelineVariable" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PipelineVariable": { - "type": "object", - "required": [ - "name", - "pipelineAgg" - ], - "properties": { - "name": { - "type": "string" - }, - "pipelineAgg": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Rate": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "rate" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "unit": { - "type": "string" - }, - "mode": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RawData": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "raw_data" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "size": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RawDocument": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "raw_document" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "size": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SerialDiff": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "serial_diff" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "lag": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Sum": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "sum" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Terms": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "terms" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/TermsSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TermsOrder": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TermsSettings": { - "type": "object", - "properties": { - "order": { - "$ref": "#/components/schemas/TermsOrder" - }, - "size": { - "type": "string" - }, - "min_doc_count": { - "type": "string" - }, - "orderBy": { - "type": "string" - }, - "missing": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TopMetrics": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "top_metrics" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "order": { - "type": "string" - }, - "orderBy": { - "type": "string" - }, - "metrics": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "UniqueCount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "cardinality" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "precision_threshold": { - "type": "string" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/gauge/panelcfg/x/gauge_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/gauge/panelcfg/x/gauge_types_gen.json deleted file mode 100644 index b1fd877..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/gauge/panelcfg/x/gauge_types_gen.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "GaugePanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "GaugePanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "showThresholdLabels": { - "type": "boolean", - "default": false - }, - "showThresholdMarkers": { - "type": "boolean", - "default": true - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/SingleStatBaseOptions" - }, - { - "required": [ - "showThresholdLabels", - "showThresholdMarkers" - ] - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ReduceDataOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "calcs" - ], - "properties": { - "values": { - "description": "If true show each row value", - "type": "boolean" - }, - "limit": { - "description": "if showing all values limit", - "type": "number" - }, - "calcs": { - "description": "When !values, pick one value for the whole field", - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "description": "Which fields to show. By default this is only numeric fields", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SingleStatBaseOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "reduceOptions": { - "$ref": "#/components/schemas/ReduceDataOptions" - }, - "orientation": { - "$ref": "#/components/schemas/VizOrientation" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "reduceOptions", - "orientation" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/geomap/panelcfg/x/geomap_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/geomap/panelcfg/x/geomap_types_gen.json deleted file mode 100644 index 39d6351..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/geomap/panelcfg/x/geomap_types_gen.json +++ /dev/null @@ -1,349 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "GeomapPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "ControlsOptions": { - "type": "object", - "properties": { - "showZoom": { - "description": "Zoom (upper left)", - "type": "boolean" - }, - "mouseWheelZoom": { - "description": "let the mouse wheel zoom", - "type": "boolean" - }, - "showAttribution": { - "description": "Lower right", - "type": "boolean" - }, - "showScale": { - "description": "Scale options", - "type": "boolean" - }, - "showDebug": { - "description": "Show debug", - "type": "boolean" - }, - "showMeasure": { - "description": "Show measure", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FrameGeometrySource": { - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/FrameGeometrySourceMode" - }, - "geohash": { - "description": "Field mappings", - "type": "string" - }, - "latitude": { - "type": "string" - }, - "longitude": { - "type": "string" - }, - "wkt": { - "type": "string" - }, - "lookup": { - "type": "string" - }, - "gazetteer": { - "description": "Path to Gazetteer", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FrameGeometrySourceMode": { - "type": "string", - "enum": [ - "auto", - "geohash", - "coords", - "lookup" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GeomapPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "MapViewConfig", - "ControlsOptions", - "TooltipOptions", - "TooltipMode", - "MapCenterID" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "view", - "controls", - "basemap", - "layers", - "tooltip" - ], - "properties": { - "view": { - "$ref": "#/components/schemas/MapViewConfig" - }, - "controls": { - "$ref": "#/components/schemas/ControlsOptions" - }, - "basemap": { - "$ref": "#/components/schemas/MapLayerOptions" - }, - "layers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapLayerOptions" - } - }, - "tooltip": { - "$ref": "#/components/schemas/TooltipOptions" - } - } - }, - "MapViewConfig": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "default": "zero" - }, - "lat": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 0 - }, - "lon": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 0 - }, - "zoom": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 1 - }, - "minZoom": { - "type": "integer", - "format": "int64" - }, - "maxZoom": { - "type": "integer", - "format": "int64" - }, - "padding": { - "type": "integer", - "format": "int64" - }, - "allLayers": { - "type": "boolean", - "default": true - }, - "lastOnly": { - "type": "boolean" - }, - "layer": { - "type": "string" - }, - "shared": { - "type": "boolean" - } - } - }, - "ControlsOptions": { - "type": "object", - "properties": { - "showZoom": { - "description": "Zoom (upper left)", - "type": "boolean" - }, - "mouseWheelZoom": { - "description": "let the mouse wheel zoom", - "type": "boolean" - }, - "showAttribution": { - "description": "Lower right", - "type": "boolean" - }, - "showScale": { - "description": "Scale options", - "type": "boolean" - }, - "showDebug": { - "description": "Show debug", - "type": "boolean" - }, - "showMeasure": { - "description": "Show measure", - "type": "boolean" - } - } - }, - "TooltipOptions": { - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipMode" - } - } - }, - "TooltipMode": { - "type": "string", - "enum": [ - "none", - "details" - ] - }, - "MapCenterID": { - "type": "string", - "enum": [ - "zero", - "coords", - "fit" - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MapLayerOptions": { - "type": "object", - "required": [ - "type", - "name" - ], - "properties": { - "type": { - "type": "string" - }, - "name": { - "description": "configured unique display name", - "type": "string" - }, - "config": { - "description": "Custom options depending on the type" - }, - "location": { - "$ref": "#/components/schemas/FrameGeometrySource" - }, - "filterData": { - "description": "Defines a frame MatcherConfig that may filter data for the given layer" - }, - "opacity": { - "description": "Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)", - "type": "integer", - "format": "int64" - }, - "tooltip": { - "description": "Check tooltip (defaults to true)", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MapViewConfig": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "default": "zero" - }, - "lat": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 0 - }, - "lon": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 0 - }, - "zoom": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 1 - }, - "minZoom": { - "type": "integer", - "format": "int64" - }, - "maxZoom": { - "type": "integer", - "format": "int64" - }, - "padding": { - "type": "integer", - "format": "int64" - }, - "allLayers": { - "type": "boolean", - "default": true - }, - "lastOnly": { - "type": "boolean" - }, - "layer": { - "type": "string" - }, - "shared": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipMode": { - "type": "string", - "enum": [ - "none", - "details" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipOptions": { - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json deleted file mode 100644 index a2f2ad7..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "GrafanaPyroscopeDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GrafanaPyroscopeDataQuery": { - "type": "object", - "properties": { - "labelSelector": { - "description": "Specifies the query label selectors.", - "type": "string", - "default": "{}" - }, - "profileTypeId": { - "description": "Specifies the type of profile to query.", - "type": "string" - }, - "groupBy": { - "description": "Allows to group the results.", - "type": "array", - "items": { - "type": "string" - } - }, - "maxNodes": { - "description": "Sets the maximum number of nodes in the flamegraph.", - "type": "integer", - "format": "int64" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "labelSelector", - "profileTypeId", - "groupBy" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PhlareQueryType": { - "type": "string", - "enum": [ - "both", - "profile", - "metrics" - ], - "default": "both", - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json deleted file mode 100644 index e7da0df..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json +++ /dev/null @@ -1,853 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "HeatmapPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CellValues": { - "description": "Controls cell value options", - "type": "object", - "properties": { - "unit": { - "description": "Controls the cell value unit", - "type": "string" - }, - "decimals": { - "description": "Controls the number of decimals for cell values", - "type": "number", - "format": "float" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ExemplarConfig": { - "description": "Controls exemplar options", - "type": "object", - "required": [ - "color" - ], - "properties": { - "color": { - "description": "Sets the color of the exemplar markers", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FilterValueRange": { - "description": "Controls the value filter range", - "type": "object", - "properties": { - "le": { - "description": "Sets the filter range to values less than or equal to the given value", - "type": "number", - "format": "float" - }, - "ge": { - "description": "Sets the filter range to values greater than or equal to the given value", - "type": "number", - "format": "float" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapCalculationBucketConfig": { - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/HeatmapCalculationMode" - }, - "value": { - "description": "The number of buckets to use for the axis in the heatmap", - "type": "string" - }, - "scale": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapCalculationMode": { - "type": "string", - "enum": [ - "size", - "count" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapCalculationOptions": { - "type": "object", - "properties": { - "xBuckets": { - "$ref": "#/components/schemas/HeatmapCalculationBucketConfig" - }, - "yBuckets": { - "$ref": "#/components/schemas/HeatmapCalculationBucketConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapCellLayout": { - "type": "string", - "enum": [ - "le", - "ge", - "unknown", - "auto" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapColorMode": { - "description": "Controls the color mode of the heatmap", - "type": "string", - "enum": [ - "opacity", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapColorOptions": { - "description": "Controls various color options", - "type": "object", - "required": [ - "scheme", - "fill", - "exponent", - "steps", - "reverse" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/HeatmapColorMode" - }, - "scheme": { - "description": "Controls the color scheme used", - "type": "string" - }, - "fill": { - "description": "Controls the color fill when in opacity mode", - "type": "string" - }, - "scale": { - "$ref": "#/components/schemas/HeatmapColorScale" - }, - "exponent": { - "description": "Controls the exponent when scale is set to exponential", - "type": "number", - "format": "float" - }, - "steps": { - "description": "Controls the number of color steps", - "type": "integer", - "minimum": 2, - "maximum": 128 - }, - "reverse": { - "description": "Reverses the color scheme", - "type": "boolean" - }, - "min": { - "description": "Sets the minimum value for the color scale", - "type": "number", - "format": "float" - }, - "max": { - "description": "Sets the maximum value for the color scale", - "type": "number", - "format": "float" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapColorScale": { - "description": "Controls the color scale of the heatmap", - "type": "string", - "enum": [ - "linear", - "exponential" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapLegend": { - "description": "Controls legend options", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "description": "Controls if the legend is shown", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapPanelCfg": { - "type": "object", - "required": [ - "HeatmapColorMode", - "HeatmapColorScale", - "HeatmapColorOptions", - "YAxisConfig", - "CellValues", - "FilterValueRange", - "HeatmapTooltip", - "HeatmapLegend", - "ExemplarConfig", - "RowsHeatmapOptions", - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "HeatmapColorMode": { - "description": "Controls the color mode of the heatmap", - "type": "string", - "enum": [ - "opacity", - "scheme" - ] - }, - "HeatmapColorScale": { - "description": "Controls the color scale of the heatmap", - "type": "string", - "enum": [ - "linear", - "exponential" - ] - }, - "HeatmapColorOptions": { - "description": "Controls various color options", - "type": "object", - "required": [ - "scheme", - "fill", - "exponent", - "steps", - "reverse" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/HeatmapColorMode" - }, - "scheme": { - "description": "Controls the color scheme used", - "type": "string" - }, - "fill": { - "description": "Controls the color fill when in opacity mode", - "type": "string" - }, - "scale": { - "$ref": "#/components/schemas/HeatmapColorScale" - }, - "exponent": { - "description": "Controls the exponent when scale is set to exponential", - "type": "number", - "format": "float" - }, - "steps": { - "description": "Controls the number of color steps", - "type": "integer", - "minimum": 2, - "maximum": 128 - }, - "reverse": { - "description": "Reverses the color scheme", - "type": "boolean" - }, - "min": { - "description": "Sets the minimum value for the color scale", - "type": "number", - "format": "float" - }, - "max": { - "description": "Sets the maximum value for the color scale", - "type": "number", - "format": "float" - } - } - }, - "YAxisConfig": { - "description": "Configuration options for the yAxis", - "type": "object", - "properties": { - "unit": { - "description": "Sets the yAxis unit", - "type": "string" - }, - "reverse": { - "description": "Reverses the yAxis", - "type": "boolean" - }, - "decimals": { - "description": "Controls the number of decimals for yAxis values", - "type": "number", - "format": "float" - }, - "min": { - "description": "Sets the minimum value for the yAxis", - "type": "number", - "format": "float" - }, - "max": { - "description": "Sets the maximum value for the yAxis", - "type": "number", - "format": "float" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AxisConfig" - } - ] - }, - "CellValues": { - "description": "Controls cell value options", - "type": "object", - "properties": { - "unit": { - "description": "Controls the cell value unit", - "type": "string" - }, - "decimals": { - "description": "Controls the number of decimals for cell values", - "type": "number", - "format": "float" - } - } - }, - "FilterValueRange": { - "description": "Controls the value filter range", - "type": "object", - "properties": { - "le": { - "description": "Sets the filter range to values less than or equal to the given value", - "type": "number", - "format": "float" - }, - "ge": { - "description": "Sets the filter range to values greater than or equal to the given value", - "type": "number", - "format": "float" - } - } - }, - "HeatmapTooltip": { - "description": "Controls tooltip options", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "description": "Controls if the tooltip is shown", - "type": "boolean" - }, - "yHistogram": { - "description": "Controls if the tooltip shows a histogram of the y-axis values", - "type": "boolean" - } - } - }, - "HeatmapLegend": { - "description": "Controls legend options", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "description": "Controls if the legend is shown", - "type": "boolean" - } - } - }, - "ExemplarConfig": { - "description": "Controls exemplar options", - "type": "object", - "required": [ - "color" - ], - "properties": { - "color": { - "description": "Sets the color of the exemplar markers", - "type": "string" - } - } - }, - "RowsHeatmapOptions": { - "description": "Controls frame rows options", - "type": "object", - "properties": { - "value": { - "description": "Sets the name of the cell when not calculating from data", - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/HeatmapCellLayout" - } - } - }, - "PanelOptions": { - "type": "object", - "required": [ - "color", - "showValue", - "yAxis", - "legend", - "tooltip", - "exemplars" - ], - "properties": { - "calculate": { - "description": "Controls if the heatmap should be calculated from data", - "type": "boolean", - "default": false - }, - "calculation": { - "$ref": "#/components/schemas/HeatmapCalculationOptions" - }, - "color": { - "description": "Controls the color options", - "type": "object", - "default": { - "scheme": "Oranges", - "fill": "dark-orange", - "reverse": false, - "exponent": 0.5, - "steps": 64 - }, - "oneOf": [ - { - "allOf": [ - { - "$ref": "#/components/schemas/HeatmapColorOptions" - }, - { - "not": { - "anyOf": [ - { - "required": [ - "scheme", - "fill", - "reverse", - "exponent", - "steps" - ], - "properties": { - "scheme": { - "description": "mode: HeatmapColorMode // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed", - "type": "string", - "enum": [ - "Oranges" - ] - }, - "fill": { - "type": "string", - "enum": [ - "dark-orange" - ] - }, - "reverse": { - "description": "scale: HeatmapColorScale // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed", - "type": "boolean", - "enum": [ - false - ] - }, - "exponent": { - "type": "number", - "enum": [ - 0.5 - ] - }, - "steps": { - "type": "integer", - "enum": [ - 64 - ] - } - } - } - ] - } - } - ] - }, - { - "required": [ - "scheme", - "fill", - "reverse", - "exponent", - "steps" - ], - "properties": { - "scheme": { - "description": "mode: HeatmapColorMode // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed", - "type": "string", - "enum": [ - "Oranges" - ] - }, - "fill": { - "type": "string", - "enum": [ - "dark-orange" - ] - }, - "reverse": { - "description": "scale: HeatmapColorScale // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed", - "type": "boolean", - "enum": [ - false - ] - }, - "exponent": { - "type": "number", - "enum": [ - 0.5 - ] - }, - "steps": { - "type": "integer", - "enum": [ - 64 - ] - } - } - } - ] - }, - "filterValues": { - "description": "Filters values between a given range", - "type": "object", - "default": { - "le": 1E-9 - }, - "oneOf": [ - { - "allOf": [ - { - "$ref": "#/components/schemas/FilterValueRange" - }, - { - "not": { - "anyOf": [ - { - "required": [ - "le" - ], - "properties": { - "le": { - "type": "number", - "enum": [ - 1E-9 - ] - } - } - } - ] - } - } - ] - }, - { - "required": [ - "le" - ], - "properties": { - "le": { - "type": "number", - "enum": [ - 1E-9 - ] - } - } - } - ] - }, - "rowsFrame": { - "$ref": "#/components/schemas/RowsHeatmapOptions" - }, - "showValue": { - "description": "| *{\n\tlayout: ui.HeatmapCellLayout \u0026 \"auto\" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed\n}\nControls the display of the value in the cell", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VisibilityMode" - } - ] - }, - "cellGap": { - "description": "Controls gap between cells", - "type": "integer", - "minimum": 0, - "maximum": 25, - "default": 1 - }, - "cellRadius": { - "description": "Controls cell radius", - "type": "number", - "format": "float" - }, - "cellValues": { - "description": "Controls cell value unit", - "type": "object", - "default": {}, - "oneOf": [ - { - "allOf": [ - { - "$ref": "#/components/schemas/CellValues" - }, - { - "not": { - "anyOf": [ - {} - ] - } - } - ] - }, - { - "not": { - "anyOf": [ - { - "$ref": "#/components/schemas/CellValues" - } - ] - } - } - ] - }, - "yAxis": { - "$ref": "#/components/schemas/YAxisConfig" - }, - "legend": { - "$ref": "#/components/schemas/HeatmapLegend" - }, - "tooltip": { - "$ref": "#/components/schemas/HeatmapTooltip" - }, - "exemplars": { - "$ref": "#/components/schemas/ExemplarConfig" - } - } - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapTooltip": { - "description": "Controls tooltip options", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "description": "Controls if the tooltip is shown", - "type": "boolean" - }, - "yHistogram": { - "description": "Controls if the tooltip shows a histogram of the y-axis values", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RowsHeatmapOptions": { - "description": "Controls frame rows options", - "type": "object", - "properties": { - "value": { - "description": "Sets the name of the cell when not calculating from data", - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/HeatmapCellLayout" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "YAxisConfig": { - "description": "Configuration options for the yAxis", - "type": "object", - "properties": { - "unit": { - "description": "Sets the yAxis unit", - "type": "string" - }, - "reverse": { - "description": "Reverses the yAxis", - "type": "boolean" - }, - "decimals": { - "description": "Controls the number of decimals for yAxis values", - "type": "number", - "format": "float" - }, - "min": { - "description": "Sets the minimum value for the yAxis", - "type": "number", - "format": "float" - }, - "max": { - "description": "Sets the maximum value for the yAxis", - "type": "number", - "format": "float" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AxisConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/histogram/panelcfg/x/histogram_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/histogram/panelcfg/x/histogram_types_gen.json deleted file mode 100644 index bd4e955..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/histogram/panelcfg/x/histogram_types_gen.json +++ /dev/null @@ -1,340 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "HistogramPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphGradientMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "opacity", - "hue", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HistogramPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "bucketSize": { - "description": "Size of each bucket", - "type": "integer", - "format": "int32" - }, - "bucketOffset": { - "description": "Offset buckets by this amount", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647, - "default": 0 - }, - "combine": { - "description": "Combines multiple series into a single histogram", - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "lineWidth": { - "description": "Controls line width of the bars.", - "type": "integer", - "minimum": 0, - "maximum": 10, - "default": 1 - }, - "fillOpacity": { - "description": "Controls the fill opacity of the bars.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "default": 80 - }, - "gradientMode": { - "description": "Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.\nGradient appearance is influenced by the Fill opacity setting.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/GraphGradientMode" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AxisConfig" - }, - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/logs/panelcfg/x/logs_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/logs/panelcfg/x/logs_types_gen.json deleted file mode 100644 index 9ea10b8..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/logs/panelcfg/x/logs_types_gen.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "LogsPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "LogsDedupStrategy": { - "type": "string", - "enum": [ - "none", - "exact", - "numbers", - "signature" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LogsPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "showLabels", - "showCommonLabels", - "showTime", - "wrapLogMessage", - "prettifyLogMessage", - "enableLogDetails", - "sortOrder", - "dedupStrategy" - ], - "properties": { - "showLabels": { - "type": "boolean" - }, - "showCommonLabels": { - "type": "boolean" - }, - "showTime": { - "type": "boolean" - }, - "wrapLogMessage": { - "type": "boolean" - }, - "prettifyLogMessage": { - "type": "boolean" - }, - "enableLogDetails": { - "type": "boolean" - }, - "sortOrder": { - "$ref": "#/components/schemas/LogsSortOrder" - }, - "dedupStrategy": { - "$ref": "#/components/schemas/LogsDedupStrategy" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LogsSortOrder": { - "type": "string", - "enum": [ - "Descending", - "Ascending" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/loki/dataquery/x/loki_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/loki/dataquery/x/loki_types_gen.json deleted file mode 100644 index 911c745..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/loki/dataquery/x/loki_types_gen.json +++ /dev/null @@ -1,116 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "LokiDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LokiDataQuery": { - "type": "object", - "properties": { - "expr": { - "description": "The LogQL query.", - "type": "string" - }, - "legendFormat": { - "description": "Used to override the name of the series.", - "type": "string" - }, - "maxLines": { - "description": "Used to limit the number of log rows returned.", - "type": "integer", - "format": "int64" - }, - "resolution": { - "description": "Used to scale the interval value.", - "type": "integer", - "format": "int64" - }, - "editorMode": { - "$ref": "#/components/schemas/QueryEditorMode" - }, - "range": { - "description": "@deprecated, now use queryType.", - "type": "boolean" - }, - "instant": { - "description": "@deprecated, now use queryType.", - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "expr" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LokiQueryDirection": { - "type": "string", - "enum": [ - "forward", - "backward" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LokiQueryType": { - "type": "string", - "enum": [ - "range", - "instant", - "stream" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorMode": { - "type": "string", - "enum": [ - "code", - "builder" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SupportingQueryType": { - "type": "string", - "enum": [ - "logsVolume", - "logsSample", - "dataSample" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/news/panelcfg/x/news_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/news/panelcfg/x/news_types_gen.json deleted file mode 100644 index be76a81..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/news/panelcfg/x/news_types_gen.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "NewsPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "NewsPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "feedUrl": { - "description": "empty/missing will default to grafana blog", - "type": "string" - }, - "showImage": { - "type": "boolean", - "default": true - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json deleted file mode 100644 index 9ced95b..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "NodeGraphPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "ArcOption": { - "type": "object", - "properties": { - "field": { - "description": "Field from which to get the value. Values should be less than 1, representing fraction of a circle.", - "type": "string" - }, - "color": { - "description": "The color of the arc.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "EdgeOptions": { - "type": "object", - "properties": { - "mainStatUnit": { - "description": "Unit for the main stat to override what ever is set in the data frame.", - "type": "string" - }, - "secondaryStatUnit": { - "description": "Unit for the secondary stat to override what ever is set in the data frame.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "NodeGraphPanelCfg": { - "type": "object", - "required": [ - "ArcOption", - "NodeOptions", - "EdgeOptions", - "PanelOptions" - ], - "properties": { - "ArcOption": { - "type": "object", - "properties": { - "field": { - "description": "Field from which to get the value. Values should be less than 1, representing fraction of a circle.", - "type": "string" - }, - "color": { - "description": "The color of the arc.", - "type": "string" - } - } - }, - "NodeOptions": { - "type": "object", - "properties": { - "mainStatUnit": { - "description": "Unit for the main stat to override what ever is set in the data frame.", - "type": "string" - }, - "secondaryStatUnit": { - "description": "Unit for the secondary stat to override what ever is set in the data frame.", - "type": "string" - }, - "arcs": { - "description": "Define which fields are shown as part of the node arc (colored circle around the node).", - "type": "array", - "items": { - "$ref": "#/components/schemas/ArcOption" - } - } - } - }, - "EdgeOptions": { - "type": "object", - "properties": { - "mainStatUnit": { - "description": "Unit for the main stat to override what ever is set in the data frame.", - "type": "string" - }, - "secondaryStatUnit": { - "description": "Unit for the secondary stat to override what ever is set in the data frame.", - "type": "string" - } - } - }, - "PanelOptions": { - "type": "object", - "properties": { - "nodes": { - "$ref": "#/components/schemas/NodeOptions" - }, - "edges": { - "$ref": "#/components/schemas/EdgeOptions" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "NodeOptions": { - "type": "object", - "properties": { - "mainStatUnit": { - "description": "Unit for the main stat to override what ever is set in the data frame.", - "type": "string" - }, - "secondaryStatUnit": { - "description": "Unit for the secondary stat to override what ever is set in the data frame.", - "type": "string" - }, - "arcs": { - "description": "Define which fields are shown as part of the node arc (colored circle around the node).", - "type": "array", - "items": { - "$ref": "#/components/schemas/ArcOption" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/parca/dataquery/x/parca_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/parca/dataquery/x/parca_types_gen.json deleted file mode 100644 index 4190fab..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/parca/dataquery/x/parca_types_gen.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "ParcaDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ParcaDataQuery": { - "type": "object", - "properties": { - "labelSelector": { - "description": "Specifies the query label selectors.", - "type": "string", - "default": "{}" - }, - "profileTypeId": { - "description": "Specifies the type of profile to query.", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "labelSelector", - "profileTypeId" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ParcaQueryType": { - "type": "string", - "enum": [ - "both", - "profile", - "metrics" - ], - "default": "both", - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/piechart/panelcfg/x/piechart_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/piechart/panelcfg/x/piechart_types_gen.json deleted file mode 100644 index 9f867e9..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/piechart/panelcfg/x/piechart_types_gen.json +++ /dev/null @@ -1,388 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "PieChartPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartLabels": { - "description": "Select labels to display on the pie chart.\n - Name - The series or field name.\n - Percent - The percentage of the whole.\n - Value - The raw numerical value.", - "type": "string", - "enum": [ - "name", - "value", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartLegendOptions": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PieChartLegendValues" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/VizLegendOptions" - }, - { - "required": [ - "values" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartLegendValues": { - "description": "Select values to display in the legend.\n - Percent: The percentage of the whole.\n - Value: The raw numerical value.", - "type": "string", - "enum": [ - "value", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartPanelCfg": { - "type": "object", - "required": [ - "PieChartType", - "PieChartLabels", - "PieChartLegendValues", - "PieChartLegendOptions", - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PieChartType": { - "description": "Select the pie chart display style.", - "type": "string", - "enum": [ - "pie", - "donut" - ] - }, - "PieChartLabels": { - "description": "Select labels to display on the pie chart.\n - Name - The series or field name.\n - Percent - The percentage of the whole.\n - Value - The raw numerical value.", - "type": "string", - "enum": [ - "name", - "value", - "percent" - ] - }, - "PieChartLegendValues": { - "description": "Select values to display in the legend.\n - Percent: The percentage of the whole.\n - Value: The raw numerical value.", - "type": "string", - "enum": [ - "value", - "percent" - ] - }, - "PieChartLegendOptions": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PieChartLegendValues" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/VizLegendOptions" - }, - { - "required": [ - "values" - ] - } - ] - }, - "PanelOptions": { - "type": "object", - "properties": { - "pieType": { - "$ref": "#/components/schemas/PieChartType" - }, - "displayLabels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PieChartLabels" - } - }, - "legend": { - "$ref": "#/components/schemas/PieChartLegendOptions" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "$ref": "#/components/schemas/SingleStatBaseOptions" - }, - { - "required": [ - "pieType", - "displayLabels", - "legend" - ] - } - ] - }, - "PanelFieldConfig": { - "$ref": "#/components/schemas/HideableFieldConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartType": { - "description": "Select the pie chart display style.", - "type": "string", - "enum": [ - "pie", - "donut" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ReduceDataOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "calcs" - ], - "properties": { - "values": { - "description": "If true show each row value", - "type": "boolean" - }, - "limit": { - "description": "if showing all values limit", - "type": "number" - }, - "calcs": { - "description": "When !values, pick one value for the whole field", - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "description": "Which fields to show. By default this is only numeric fields", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SingleStatBaseOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "reduceOptions": { - "$ref": "#/components/schemas/ReduceDataOptions" - }, - "orientation": { - "$ref": "#/components/schemas/VizOrientation" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "reduceOptions", - "orientation" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json deleted file mode 100644 index 2659c59..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "PrometheusDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PromQueryFormat": { - "type": "string", - "enum": [ - "time_series", - "table", - "heatmap" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PrometheusDataQuery": { - "type": "object", - "properties": { - "expr": { - "description": "The actual expression/query that will be evaluated by Prometheus", - "type": "string" - }, - "instant": { - "description": "Returns only the latest value that Prometheus has scraped for the requested time series", - "type": "boolean" - }, - "range": { - "description": "Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series", - "type": "boolean" - }, - "exemplar": { - "description": "Execute an additional query to identify interesting raw samples relevant for the given expr", - "type": "boolean" - }, - "editorMode": { - "$ref": "#/components/schemas/QueryEditorMode" - }, - "format": { - "$ref": "#/components/schemas/PromQueryFormat" - }, - "legendFormat": { - "description": "Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname", - "type": "string" - }, - "intervalFactor": { - "description": "@deprecated Used to specify how many times to divide max data points by. We use max data points under query options\nSee https://github.com/grafana/grafana/issues/48081", - "type": "number" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "expr" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorMode": { - "type": "string", - "enum": [ - "code", - "builder" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/stat/panelcfg/x/stat_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/stat/panelcfg/x/stat_types_gen.json deleted file mode 100644 index 309e9d7..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/stat/panelcfg/x/stat_types_gen.json +++ /dev/null @@ -1,185 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "StatPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "BigValueColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "value", - "background", - "background_solid", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BigValueGraphMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "line", - "area" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BigValueJustifyMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "center" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BigValueTextMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "value", - "value_and_name", - "name", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ReduceDataOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "calcs" - ], - "properties": { - "values": { - "description": "If true show each row value", - "type": "boolean" - }, - "limit": { - "description": "if showing all values limit", - "type": "number" - }, - "calcs": { - "description": "When !values, pick one value for the whole field", - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "description": "Which fields to show. By default this is only numeric fields", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SingleStatBaseOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "reduceOptions": { - "$ref": "#/components/schemas/ReduceDataOptions" - }, - "orientation": { - "$ref": "#/components/schemas/VizOrientation" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "reduceOptions", - "orientation" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StatPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "graphMode": { - "type": "string", - "$ref": "#/components/schemas/BigValueGraphMode" - }, - "colorMode": { - "type": "string", - "$ref": "#/components/schemas/BigValueColorMode" - }, - "justifyMode": { - "type": "string", - "$ref": "#/components/schemas/BigValueJustifyMode" - }, - "textMode": { - "type": "string", - "$ref": "#/components/schemas/BigValueTextMode" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/SingleStatBaseOptions" - }, - { - "required": [ - "graphMode", - "colorMode", - "justifyMode", - "textMode" - ] - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json deleted file mode 100644 index 33636f0..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json +++ /dev/null @@ -1,298 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "StateTimelinePanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTimezones": { - "description": "TODO docs", - "type": "object", - "properties": { - "timezone": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TimeZone" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StateTimelinePanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "showValue": { - "description": "Show timeline values on chart", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VisibilityMode" - } - ] - }, - "rowHeight": { - "description": "Controls the row height", - "type": "number", - "maximum": 1, - "default": 0.9 - }, - "mergeValues": { - "description": "Merge equal consecutive values", - "type": "boolean", - "default": true - }, - "alignValue": { - "description": "Controls value alignment on the timelines", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/TimelineValueAlignment" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "$ref": "#/components/schemas/OptionsWithTimezones" - }, - { - "required": [ - "showValue", - "rowHeight" - ] - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "lineWidth": { - "type": "integer", - "minimum": 0, - "maximum": 10, - "default": 0 - }, - "fillOpacity": { - "type": "integer", - "minimum": 0, - "maximum": 100, - "default": 70 - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimeZone": { - "description": "A specific timezone from https://en.wikipedia.org/wiki/Tz_database", - "type": "string", - "default": "browser", - "oneOf": [ - { - "enum": [ - "utc" - ] - }, - {} - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimelineValueAlignment": { - "description": "Controls the value alignment in the TimelineChart component", - "type": "string", - "enum": [ - "center", - "left", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json deleted file mode 100644 index 7f7bcb7..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json +++ /dev/null @@ -1,281 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "StatusHistoryPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTimezones": { - "description": "TODO docs", - "type": "object", - "properties": { - "timezone": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TimeZone" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StatusHistoryPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "rowHeight": { - "description": "Set the height of the rows", - "type": "number", - "minimum": 0, - "maximum": 1, - "default": 0.9 - }, - "showValue": { - "description": "Show values on the columns", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VisibilityMode" - } - ] - }, - "colWidth": { - "description": "Controls the column width", - "type": "number", - "maximum": 1, - "default": 0.9 - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "$ref": "#/components/schemas/OptionsWithTimezones" - }, - { - "required": [ - "rowHeight", - "showValue" - ] - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "lineWidth": { - "type": "integer", - "minimum": 0, - "maximum": 10, - "default": 1 - }, - "fillOpacity": { - "type": "integer", - "minimum": 0, - "maximum": 100, - "default": 70 - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimeZone": { - "description": "A specific timezone from https://en.wikipedia.org/wiki/Tz_database", - "type": "string", - "default": "browser", - "oneOf": [ - { - "enum": [ - "utc" - ] - }, - {} - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/table/panelcfg/x/table_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/table/panelcfg/x/table_types_gen.json deleted file mode 100644 index 8804297..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/table/panelcfg/x/table_types_gen.json +++ /dev/null @@ -1,205 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TablePanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "TableCellHeight": { - "description": "Height of a table cell", - "type": "string", - "enum": [ - "sm", - "md", - "lg" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TableFooterOptions": { - "description": "Footer options", - "type": "object", - "required": [ - "show", - "reducer" - ], - "properties": { - "show": { - "type": "boolean" - }, - "reducer": { - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "enablePagination": { - "type": "boolean" - }, - "countRows": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TablePanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "frameIndex", - "showHeader" - ], - "properties": { - "frameIndex": { - "description": "Represents the index of the selected frame", - "type": "number", - "default": 0 - }, - "showHeader": { - "description": "Controls whether the panel should show the header", - "type": "boolean", - "default": true - }, - "showTypeIcons": { - "description": "Controls whether the header should show icons for the column types", - "type": "boolean", - "default": false - }, - "sortBy": { - "description": "Used to control row sorting", - "type": "array", - "items": { - "$ref": "#/components/schemas/TableSortByFieldState" - } - }, - "footer": { - "description": "Controls footer options", - "type": "object", - "default": { - "show": false, - "countRows": false, - "reducer": [] - }, - "oneOf": [ - { - "allOf": [ - { - "$ref": "#/components/schemas/TableFooterOptions" - }, - { - "not": { - "anyOf": [ - { - "required": [ - "show", - "countRows", - "reducer" - ], - "properties": { - "show": { - "description": "Controls whether the footer should be shown", - "type": "boolean", - "enum": [ - false - ] - }, - "countRows": { - "description": "Controls whether the footer should show the total number of rows on Count calculation", - "type": "boolean", - "enum": [ - false - ] - }, - "reducer": { - "description": "Represents the selected calculations", - "type": "array", - "enum": [ - [] - ] - } - } - } - ] - } - } - ] - }, - { - "required": [ - "show", - "countRows", - "reducer" - ], - "properties": { - "show": { - "description": "Controls whether the footer should be shown", - "type": "boolean", - "enum": [ - false - ] - }, - "countRows": { - "description": "Controls whether the footer should show the total number of rows on Count calculation", - "type": "boolean", - "enum": [ - false - ] - }, - "reducer": { - "description": "Represents the selected calculations", - "type": "array", - "enum": [ - [] - ] - } - } - } - ] - }, - "cellHeight": { - "description": "Controls the height of the rows", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/TableCellHeight" - } - ] - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TableSortByFieldState": { - "description": "Sort by field state", - "type": "object", - "required": [ - "displayName" - ], - "properties": { - "displayName": { - "description": "Sets the display name of the field to sort by", - "type": "string" - }, - "desc": { - "description": "Flag used to indicate descending sort order", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/tempo/dataquery/x/tempo_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/tempo/dataquery/x/tempo_types_gen.json deleted file mode 100644 index 963656a..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/tempo/dataquery/x/tempo_types_gen.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TempoDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TempoDataQuery": { - "type": "object", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TempoQuery": { - "type": "object", - "properties": { - "query": { - "description": "TraceQL query or trace ID", - "type": "string" - }, - "search": { - "description": "Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true", - "type": "string" - }, - "serviceName": { - "description": "Query traces by service name", - "type": "string" - }, - "spanName": { - "description": "Query traces by span name", - "type": "string" - }, - "minDuration": { - "description": "Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms", - "type": "string" - }, - "maxDuration": { - "description": "Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms", - "type": "string" - }, - "serviceMapQuery": { - "description": "Filters to be included in a PromQL query to select data for the service graph. Example: {client=\"app\",service=\"app\"}", - "type": "string" - }, - "limit": { - "description": "Defines the maximum number of traces that are returned from Tempo", - "type": "integer", - "format": "int64" - }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TraceqlFilter" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "query", - "filters" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TempoQueryType": { - "description": "search = Loki search, nativeSearch = Tempo search for backwards compatibility", - "type": "string", - "enum": [ - "traceql", - "traceqlSearch", - "search", - "serviceMap", - "upload", - "nativeSearch", - "clear" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TraceqlFilter": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "description": "Uniquely identify the filter, will not be used in the query generation", - "type": "string" - }, - "tag": { - "description": "The tag for the search filter, for example: .http.status_code, .service.name, status", - "type": "string" - }, - "operator": { - "description": "The operator that connects the tag to the value, for example: =, \u003e, !=, =~", - "type": "string" - }, - "value": { - "description": "The value for the search filter", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "valueType": { - "description": "The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query", - "type": "string" - }, - "scope": { - "$ref": "#/components/schemas/TraceqlSearchScope" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TraceqlSearchScope": { - "description": "static fields are pre-set in the UI, dynamic fields are added by the user", - "type": "string", - "enum": [ - "unscoped", - "resource", - "span" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/testdata/dataquery/x/testdata_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/testdata/dataquery/x/testdata_types_gen.json deleted file mode 100644 index 5776843..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/testdata/dataquery/x/testdata_types_gen.json +++ /dev/null @@ -1,360 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TestDataDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "CSVWave": { - "type": "object", - "properties": { - "timeStep": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "valuesCSV": { - "type": "string" - }, - "labels": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "NodesQuery": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "random", - "response", - "random edges" - ] - }, - "count": { - "type": "integer", - "format": "int64" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PulseWaveQuery": { - "type": "object", - "properties": { - "timeStep": { - "type": "integer", - "format": "int64" - }, - "onCount": { - "type": "integer", - "format": "int64" - }, - "offCount": { - "type": "integer", - "format": "int64" - }, - "onValue": { - "type": "number", - "format": "double" - }, - "offValue": { - "type": "number", - "format": "double" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Scenario": { - "description": "TODO: Should this live here given it's not used in the dataquery?", - "type": "object", - "required": [ - "id", - "name", - "stringInput" - ], - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "stringInput": { - "type": "string" - }, - "description": { - "type": "string" - }, - "hideAliasField": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SimulationQuery": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "object", - "required": [ - "type", - "tick" - ], - "properties": { - "type": { - "type": "string" - }, - "tick": { - "type": "number", - "format": "double" - }, - "uid": { - "type": "string" - } - } - }, - "config": { - "type": "object" - }, - "stream": { - "type": "boolean" - }, - "last": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StreamingQuery": { - "type": "object", - "required": [ - "type", - "speed", - "spread", - "noise" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "signal", - "logs", - "fetch" - ] - }, - "speed": { - "type": "integer", - "format": "int32" - }, - "spread": { - "type": "integer", - "format": "int32" - }, - "noise": { - "type": "integer", - "format": "int32" - }, - "bands": { - "type": "integer", - "format": "int32" - }, - "url": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TestDataDataQuery": { - "type": "object", - "properties": { - "alias": { - "type": "string" - }, - "scenarioId": { - "type": "string", - "$ref": "#/components/schemas/TestDataQueryType" - }, - "stringInput": { - "type": "string" - }, - "stream": { - "$ref": "#/components/schemas/StreamingQuery" - }, - "pulseWave": { - "$ref": "#/components/schemas/PulseWaveQuery" - }, - "sim": { - "$ref": "#/components/schemas/SimulationQuery" - }, - "csvWave": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CSVWave" - } - }, - "labels": { - "type": "string" - }, - "lines": { - "type": "integer", - "format": "int64" - }, - "levelColumn": { - "type": "boolean" - }, - "channel": { - "type": "string" - }, - "nodes": { - "$ref": "#/components/schemas/NodesQuery" - }, - "csvFileName": { - "type": "string" - }, - "csvContent": { - "type": "string" - }, - "rawFrameContent": { - "type": "string" - }, - "seriesCount": { - "type": "integer", - "format": "int32" - }, - "usa": { - "$ref": "#/components/schemas/USAQuery" - }, - "errorType": { - "type": "string", - "enum": [ - "server_panic", - "frontend_exception", - "frontend_observable" - ] - }, - "spanCount": { - "type": "integer", - "format": "int32" - }, - "points": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807 - } - ] - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TestDataQueryType": { - "type": "string", - "enum": [ - "random_walk", - "slow_query", - "random_walk_with_error", - "random_walk_table", - "exponential_heatmap_bucket_data", - "linear_heatmap_bucket_data", - "no_data_points", - "datapoints_outside_range", - "csv_metric_values", - "predictable_pulse", - "predictable_csv_wave", - "streaming_client", - "simulation", - "usa", - "live", - "grafana_api", - "arrow", - "annotations", - "table_static", - "server_error_500", - "logs", - "node_graph", - "flame_graph", - "raw_frame", - "csv_file", - "csv_content", - "trace", - "manual_entry", - "variables-query" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "USAQuery": { - "type": "object", - "properties": { - "mode": { - "type": "string" - }, - "period": { - "type": "string" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "states": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/text/panelcfg/x/text_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/text/panelcfg/x/text_types_gen.json deleted file mode 100644 index b0701ec..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/text/panelcfg/x/text_types_gen.json +++ /dev/null @@ -1,135 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TextPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "CodeLanguage": { - "type": "string", - "enum": [ - "plaintext", - "yaml", - "xml", - "typescript", - "sql", - "go", - "markdown", - "html", - "json" - ], - "default": "plaintext", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CodeOptions": { - "type": "object", - "required": [ - "language", - "showLineNumbers", - "showMiniMap" - ], - "properties": { - "language": { - "$ref": "#/components/schemas/CodeLanguage" - }, - "showLineNumbers": { - "type": "boolean", - "default": false - }, - "showMiniMap": { - "type": "boolean", - "default": false - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TextMode": { - "type": "string", - "enum": [ - "html", - "markdown", - "code" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TextPanelCfg": { - "type": "object", - "required": [ - "TextMode", - "CodeLanguage", - "CodeOptions", - "PanelOptions" - ], - "properties": { - "TextMode": { - "type": "string", - "enum": [ - "html", - "markdown", - "code" - ] - }, - "CodeLanguage": { - "type": "string", - "enum": [ - "plaintext", - "yaml", - "xml", - "typescript", - "sql", - "go", - "markdown", - "html", - "json" - ], - "default": "plaintext" - }, - "CodeOptions": { - "type": "object", - "required": [ - "language", - "showLineNumbers", - "showMiniMap" - ], - "properties": { - "language": { - "$ref": "#/components/schemas/CodeLanguage" - }, - "showLineNumbers": { - "type": "boolean", - "default": false - }, - "showMiniMap": { - "type": "boolean", - "default": false - } - } - }, - "PanelOptions": { - "type": "object", - "required": [ - "mode", - "content" - ], - "properties": { - "mode": { - "type": "string", - "$ref": "#/components/schemas/TextMode" - }, - "code": { - "$ref": "#/components/schemas/CodeOptions" - }, - "content": { - "type": "string", - "default": "# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json deleted file mode 100644 index 1f71e94..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json +++ /dev/null @@ -1,557 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TimeSeriesPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarAlignment": { - "description": "TODO docs", - "type": "integer", - "enum": [ - -1, - 0, - 1 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "barAlignment": { - "$ref": "#/components/schemas/BarAlignment" - }, - "barWidthFactor": { - "type": "number" - }, - "barMaxWidth": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FillConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "fillColor": { - "type": "string" - }, - "fillOpacity": { - "type": "number" - }, - "fillBelowTo": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphDrawStyle": { - "description": "TODO docs", - "type": "string", - "enum": [ - "line", - "bars", - "points" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "drawStyle": { - "$ref": "#/components/schemas/GraphDrawStyle" - }, - "gradientMode": { - "$ref": "#/components/schemas/GraphGradientMode" - }, - "thresholdsStyle": { - "$ref": "#/components/schemas/GraphThresholdsStyleConfig" - }, - "transform": { - "$ref": "#/components/schemas/GraphTransform" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/LineConfig" - }, - { - "$ref": "#/components/schemas/FillConfig" - }, - { - "$ref": "#/components/schemas/PointsConfig" - }, - { - "$ref": "#/components/schemas/AxisConfig" - }, - { - "$ref": "#/components/schemas/BarConfig" - }, - { - "$ref": "#/components/schemas/StackableFieldConfig" - }, - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphGradientMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "opacity", - "hue", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphThresholdsStyleConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/GraphTresholdsStyleMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTransform": { - "description": "TODO docs", - "type": "string", - "enum": [ - "constant", - "negative-Y" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTresholdsStyleMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "off", - "line", - "dashed", - "area", - "line+area", - "dashed+area", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "lineColor": { - "type": "string" - }, - "lineWidth": { - "type": "number" - }, - "lineInterpolation": { - "$ref": "#/components/schemas/LineInterpolation" - }, - "lineStyle": { - "$ref": "#/components/schemas/LineStyle" - }, - "spanNulls": { - "description": "Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "number" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineInterpolation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "smooth", - "stepBefore", - "stepAfter" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineStyle": { - "description": "TODO docs", - "type": "object", - "properties": { - "fill": { - "type": "string", - "enum": [ - "solid", - "dash", - "dot", - "square" - ] - }, - "dash": { - "type": "array", - "items": { - "type": "number" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTimezones": { - "description": "TODO docs", - "type": "object", - "properties": { - "timezone": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TimeZone" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PointsConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "showPoints": { - "$ref": "#/components/schemas/VisibilityMode" - }, - "pointSize": { - "type": "number" - }, - "pointColor": { - "type": "string" - }, - "pointSymbol": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "stacking": { - "$ref": "#/components/schemas/StackingConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/StackingMode" - }, - "group": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "normal", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimeSeriesPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - }, - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTimezones" - }, - { - "required": [ - "legend", - "tooltip" - ] - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "$ref": "#/components/schemas/GraphFieldConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimeZone": { - "description": "A specific timezone from https://en.wikipedia.org/wiki/Tz_database", - "type": "string", - "default": "browser", - "oneOf": [ - { - "enum": [ - "utc" - ] - }, - {} - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/trend/panelcfg/x/trend_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/trend/panelcfg/x/trend_types_gen.json deleted file mode 100644 index 3172e8a..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/trend/panelcfg/x/trend_types_gen.json +++ /dev/null @@ -1,528 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TrendPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarAlignment": { - "description": "TODO docs", - "type": "integer", - "enum": [ - -1, - 0, - 1 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "barAlignment": { - "$ref": "#/components/schemas/BarAlignment" - }, - "barWidthFactor": { - "type": "number" - }, - "barMaxWidth": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FillConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "fillColor": { - "type": "string" - }, - "fillOpacity": { - "type": "number" - }, - "fillBelowTo": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphDrawStyle": { - "description": "TODO docs", - "type": "string", - "enum": [ - "line", - "bars", - "points" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "drawStyle": { - "$ref": "#/components/schemas/GraphDrawStyle" - }, - "gradientMode": { - "$ref": "#/components/schemas/GraphGradientMode" - }, - "thresholdsStyle": { - "$ref": "#/components/schemas/GraphThresholdsStyleConfig" - }, - "transform": { - "$ref": "#/components/schemas/GraphTransform" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/LineConfig" - }, - { - "$ref": "#/components/schemas/FillConfig" - }, - { - "$ref": "#/components/schemas/PointsConfig" - }, - { - "$ref": "#/components/schemas/AxisConfig" - }, - { - "$ref": "#/components/schemas/BarConfig" - }, - { - "$ref": "#/components/schemas/StackableFieldConfig" - }, - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphGradientMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "opacity", - "hue", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphThresholdsStyleConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/GraphTresholdsStyleMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTransform": { - "description": "TODO docs", - "type": "string", - "enum": [ - "constant", - "negative-Y" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTresholdsStyleMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "off", - "line", - "dashed", - "area", - "line+area", - "dashed+area", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "lineColor": { - "type": "string" - }, - "lineWidth": { - "type": "number" - }, - "lineInterpolation": { - "$ref": "#/components/schemas/LineInterpolation" - }, - "lineStyle": { - "$ref": "#/components/schemas/LineStyle" - }, - "spanNulls": { - "description": "Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "number" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineInterpolation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "smooth", - "stepBefore", - "stepAfter" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineStyle": { - "description": "TODO docs", - "type": "object", - "properties": { - "fill": { - "type": "string", - "enum": [ - "solid", - "dash", - "dot", - "square" - ] - }, - "dash": { - "type": "array", - "items": { - "type": "number" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PointsConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "showPoints": { - "$ref": "#/components/schemas/VisibilityMode" - }, - "pointSize": { - "type": "number" - }, - "pointColor": { - "type": "string" - }, - "pointSymbol": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "stacking": { - "$ref": "#/components/schemas/StackingConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/StackingMode" - }, - "group": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "normal", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TrendPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "description": "Identical to timeseries... except it does not have timezone settings", - "type": "object", - "required": [ - "legend", - "tooltip" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - }, - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - }, - "xField": { - "description": "Name of the x field to use (defaults to first number)", - "type": "string" - } - } - }, - "PanelFieldConfig": { - "type": "object", - "$ref": "#/components/schemas/GraphFieldConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/xychart/panelcfg/x/xychart_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/xychart/panelcfg/x/xychart_types_gen.json deleted file mode 100644 index 42c820c..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/xychart/panelcfg/x/xychart_types_gen.json +++ /dev/null @@ -1,622 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "XYChartPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseDimensionConfig": { - "type": "object", - "properties": { - "field": { - "description": "fixed: T -- will be added by each element", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ColorDimensionConfig": { - "type": "object", - "properties": { - "fixed": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseDimensionConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineStyle": { - "description": "TODO docs", - "type": "object", - "properties": { - "fill": { - "type": "string", - "enum": [ - "solid", - "dash", - "dot", - "square" - ] - }, - "dash": { - "type": "array", - "items": { - "type": "number" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDimensionConfig": { - "type": "object", - "properties": { - "min": { - "type": "number" - }, - "max": { - "type": "number" - }, - "fixed": { - "type": "number" - }, - "mode": { - "$ref": "#/components/schemas/ScaleDimensionMode" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseDimensionConfig" - }, - { - "required": [ - "min", - "max" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDimensionMode": { - "type": "string", - "enum": [ - "linear", - "quad" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScatterFieldConfig": { - "type": "object", - "properties": { - "show": { - "type": "string", - "$ref": "#/components/schemas/ScatterShow" - }, - "pointSize": { - "$ref": "#/components/schemas/ScaleDimensionConfig" - }, - "lineColor": { - "$ref": "#/components/schemas/ColorDimensionConfig" - }, - "pointColor": { - "$ref": "#/components/schemas/ColorDimensionConfig" - }, - "labelValue": { - "$ref": "#/components/schemas/TextDimensionConfig" - }, - "lineWidth": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "lineStyle": { - "$ref": "#/components/schemas/LineStyle" - }, - "label": { - "type": "string", - "$ref": "#/components/schemas/VisibilityMode" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - }, - { - "$ref": "#/components/schemas/AxisConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScatterSeriesConfig": { - "type": "object", - "properties": { - "x": { - "type": "string" - }, - "y": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/ScatterFieldConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScatterShow": { - "type": "string", - "enum": [ - "points", - "lines", - "points+lines" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SeriesMapping": { - "type": "string", - "enum": [ - "auto", - "manual" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TextDimensionConfig": { - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/TextDimensionMode" - }, - "fixed": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseDimensionConfig" - }, - { - "required": [ - "mode" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TextDimensionMode": { - "type": "string", - "enum": [ - "fixed", - "field", - "template" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "XYChartPanelCfg": { - "type": "object", - "required": [ - "SeriesMapping", - "ScatterShow", - "XYDimensionConfig", - "ScatterFieldConfig", - "ScatterSeriesConfig", - "PanelOptions" - ], - "properties": { - "SeriesMapping": { - "type": "string", - "enum": [ - "auto", - "manual" - ] - }, - "ScatterShow": { - "type": "string", - "enum": [ - "points", - "lines", - "points+lines" - ] - }, - "XYDimensionConfig": { - "type": "object", - "required": [ - "frame" - ], - "properties": { - "frame": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "x": { - "type": "string" - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ScatterFieldConfig": { - "type": "object", - "properties": { - "show": { - "type": "string", - "$ref": "#/components/schemas/ScatterShow" - }, - "pointSize": { - "$ref": "#/components/schemas/ScaleDimensionConfig" - }, - "lineColor": { - "$ref": "#/components/schemas/ColorDimensionConfig" - }, - "pointColor": { - "$ref": "#/components/schemas/ColorDimensionConfig" - }, - "labelValue": { - "$ref": "#/components/schemas/TextDimensionConfig" - }, - "lineWidth": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "lineStyle": { - "$ref": "#/components/schemas/LineStyle" - }, - "label": { - "type": "string", - "$ref": "#/components/schemas/VisibilityMode" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - }, - { - "$ref": "#/components/schemas/AxisConfig" - } - ] - }, - "ScatterSeriesConfig": { - "type": "object", - "properties": { - "x": { - "type": "string" - }, - "y": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/ScatterFieldConfig" - } - ] - }, - "PanelOptions": { - "type": "object", - "properties": { - "seriesMapping": { - "$ref": "#/components/schemas/SeriesMapping" - }, - "dims": { - "$ref": "#/components/schemas/XYDimensionConfig" - }, - "series": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScatterSeriesConfig" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "required": [ - "dims", - "series" - ] - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "XYDimensionConfig": { - "type": "object", - "required": [ - "frame" - ], - "properties": { - "frame": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "x": { - "type": "string" - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/dashboard/x/dashboard_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/dashboard/x/dashboard_types_gen.json deleted file mode 100644 index 6fb102e..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/dashboard/x/dashboard_types_gen.json +++ /dev/null @@ -1,1630 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "dashboard", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AnnotationContainer": { - "description": "TODO -- should not be a public interface on its own, but required for Veneer", - "type": "object", - "properties": { - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AnnotationQuery" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AnnotationPanelFilter": { - "type": "object", - "required": [ - "ids" - ], - "properties": { - "exclude": { - "description": "Should the specified panels be included or excluded", - "type": "boolean", - "default": false - }, - "ids": { - "description": "Panel IDs that should be included or excluded", - "type": "array", - "items": { - "type": "integer", - "minimum": 0, - "maximum": 255 - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AnnotationQuery": { - "description": "TODO docs\nFROM: AnnotationQuery in grafana-data/src/types/annotations.ts", - "type": "object", - "required": [ - "name", - "datasource", - "enable", - "iconColor" - ], - "properties": { - "name": { - "description": "Name of annotation.", - "type": "string" - }, - "datasource": { - "description": "TODO: Should be DataSourceRef", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "uid": { - "type": "string" - } - } - }, - "enable": { - "description": "When enabled the annotation query is issued with every dashboard refresh", - "type": "boolean", - "default": true - }, - "hide": { - "description": "Annotation queries can be toggled on or off at the top of the dashboard.\nWhen hide is true, the toggle is not shown in the dashboard.", - "type": "boolean", - "default": false - }, - "iconColor": { - "description": "Color to use for the annotation event markers", - "type": "string" - }, - "filter": { - "$ref": "#/components/schemas/AnnotationPanelFilter" - }, - "target": { - "$ref": "#/components/schemas/AnnotationTarget" - }, - "type": { - "description": "TODO -- this should not exist here, it is based on the --grafana-- datasource", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AnnotationTarget": { - "description": "TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the \"grafana\" datasouce that is default in most dashboards", - "type": "object", - "required": [ - "limit", - "matchAny", - "tags", - "type" - ], - "properties": { - "limit": { - "description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change", - "type": "integer", - "format": "int64" - }, - "matchAny": { - "description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change", - "type": "boolean" - }, - "tags": { - "description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change", - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DashboardCursorSync": { - "description": "0 for no shared crosshair or tooltip (default).\n1 for shared crosshair.\n2 for shared crosshair AND shared tooltip.", - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "default": 0, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DashboardLink": { - "description": "FROM public/app/features/dashboard/state/DashboardModels.ts - ish\nTODO docs", - "type": "object", - "required": [ - "title", - "type", - "icon", - "tooltip", - "url", - "tags", - "asDropdown", - "targetBlank", - "includeVars", - "keepTime" - ], - "properties": { - "title": { - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/DashboardLinkType" - }, - "icon": { - "type": "string" - }, - "tooltip": { - "type": "string" - }, - "url": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "asDropdown": { - "type": "boolean", - "default": false - }, - "targetBlank": { - "type": "boolean", - "default": false - }, - "includeVars": { - "type": "boolean", - "default": false - }, - "keepTime": { - "type": "boolean", - "default": false - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DashboardLinkType": { - "description": "TODO docs", - "type": "string", - "enum": [ - "link", - "dashboards" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataSourceRef": { - "description": "Ref to a DataSource instance", - "type": "object", - "properties": { - "type": { - "description": "The plugin type-id", - "type": "string" - }, - "uid": { - "description": "Specific datasource instance", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataTransformerConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "id", - "options" - ], - "properties": { - "id": { - "description": "Unique identifier of transformer", - "type": "string" - }, - "disabled": { - "description": "Disabled transformations are skipped", - "type": "boolean" - }, - "filter": { - "$ref": "#/components/schemas/MatcherConfig" - }, - "options": { - "description": "Options to be passed to the transformer\nValid options depend on the transformer id" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DynamicConfigValue": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "default": "" - }, - "value": {} - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldColor": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "description": "The main color scheme mode", - "type": "string", - "oneOf": [ - { - "enum": [ - "thresholds", - "palette-classic", - "palette-saturated", - "continuous-GrYlRd", - "fixed" - ] - }, - {} - ] - }, - "fixedColor": { - "description": "Stores the fixed color value if mode is fixed", - "type": "string" - }, - "seriesBy": { - "$ref": "#/components/schemas/FieldColorSeriesByMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldColorModeId": { - "description": "TODO docs", - "type": "string", - "enum": [ - "thresholds", - "palette-classic", - "palette-saturated", - "continuous-GrYlRd", - "fixed" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldColorSeriesByMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "min", - "max", - "last" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldConfig": { - "type": "object", - "properties": { - "displayName": { - "description": "The display value for this field. This supports template variables blank is auto", - "type": "string" - }, - "displayNameFromDS": { - "description": "This can be used by data sources that return and explicit naming structure for values and labels\nWhen this property is configured, this value is used rather than the default naming strategy.", - "type": "string" - }, - "description": { - "description": "Human readable field metadata", - "type": "string" - }, - "path": { - "description": "An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results", - "type": "string" - }, - "writeable": { - "description": "True if data source can write a value to the path. Auth/authz are supported separately", - "type": "boolean" - }, - "filterable": { - "description": "True if data source field supports ad-hoc filters", - "type": "boolean" - }, - "unit": { - "description": "Numeric Options", - "type": "string" - }, - "decimals": { - "description": "Significant digits (for display)", - "type": "number" - }, - "min": { - "type": "number" - }, - "max": { - "type": "number" - }, - "mappings": { - "description": "Convert input values into a display string", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValueMapping" - } - }, - "thresholds": { - "$ref": "#/components/schemas/ThresholdsConfig" - }, - "color": { - "$ref": "#/components/schemas/FieldColor" - }, - "links": { - "description": "The behavior when clicking on a result", - "type": "array", - "items": {} - }, - "noValue": { - "description": "Alternative to empty string", - "type": "string" - }, - "custom": { - "description": "custom is specified by the PanelFieldConfig field\nin panel plugin schemas.", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldConfigSource": { - "type": "object", - "required": [ - "defaults", - "overrides" - ], - "properties": { - "defaults": { - "$ref": "#/components/schemas/FieldConfig" - }, - "overrides": { - "type": "array", - "items": { - "type": "object", - "required": [ - "matcher", - "properties" - ], - "properties": { - "matcher": { - "$ref": "#/components/schemas/MatcherConfig" - }, - "properties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DynamicConfigValue" - } - } - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphPanel": { - "description": "Support for legacy graph and heatmap panels.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "graph" - ] - }, - "legend": { - "description": "@deprecated this is part of deprecated graph panel", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "type": "boolean", - "default": true - }, - "sort": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GridPos": { - "type": "object", - "required": [ - "h", - "w", - "x", - "y" - ], - "properties": { - "h": { - "description": "Panel", - "type": "integer", - "minimum": 0, - "exclusiveMinimum": true, - "maximum": 4294967295, - "default": 9 - }, - "w": { - "description": "Panel", - "type": "integer", - "minimum": 0, - "exclusiveMinimum": true, - "maximum": 24, - "default": 12 - }, - "x": { - "description": "Panel x", - "type": "integer", - "minimum": 0, - "maximum": 24, - "exclusiveMaximum": true, - "default": 0 - }, - "y": { - "description": "Panel y", - "type": "integer", - "minimum": 0, - "maximum": 4294967295, - "default": 0 - }, - "static": { - "description": "true if fixed", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapPanel": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "heatmap" - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LibraryPanelRef": { - "type": "object", - "required": [ - "name", - "uid" - ], - "properties": { - "name": { - "type": "string" - }, - "uid": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LoadingState": { - "type": "string", - "enum": [ - "NotStarted", - "Loading", - "Streaming", - "Done", - "Error" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MappingType": { - "description": "TODO docs", - "type": "string", - "enum": [ - "value", - "range", - "regex", - "special" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MatcherConfig": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "default": "" - }, - "options": {} - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Panel": { - "description": "Dashboard panels. Panels are canonically defined inline\nbecause they share a version timeline with the dashboard\nschema; they do not evolve independently.", - "type": "object", - "required": [ - "type", - "transparent", - "repeatDirection", - "transformations", - "options", - "fieldConfig" - ], - "properties": { - "type": { - "description": "The panel plugin type id. May not be empty.", - "type": "string", - "minLength": 1 - }, - "id": { - "description": "TODO docs", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "pluginVersion": { - "description": "FIXME this almost certainly has to be changed in favor of scuemata versions", - "type": "string" - }, - "tags": { - "description": "TODO docs", - "type": "array", - "items": { - "type": "string" - } - }, - "targets": { - "description": "TODO docs", - "type": "array", - "items": { - "$ref": "#/components/schemas/Target" - } - }, - "title": { - "description": "Panel title.", - "type": "string" - }, - "description": { - "description": "Description.", - "type": "string" - }, - "transparent": { - "description": "Whether to display the panel without a background.", - "type": "boolean", - "default": false - }, - "datasource": { - "description": "The datasource used in all targets.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "uid": { - "type": "string" - } - } - }, - "gridPos": { - "$ref": "#/components/schemas/GridPos" - }, - "links": { - "description": "Panel links.\nTODO fill this out - seems there are a couple variants?", - "type": "array", - "items": { - "$ref": "#/components/schemas/DashboardLink" - } - }, - "repeat": { - "description": "Name of template variable to repeat for.", - "type": "string" - }, - "repeatDirection": { - "description": "Direction to repeat in if 'repeat' is set.\n\"h\" for horizontal, \"v\" for vertical.\nTODO this is probably optional", - "type": "string", - "enum": [ - "h", - "v" - ], - "default": "h" - }, - "repeatPanelId": { - "description": "Id of the repeating panel.", - "type": "integer", - "format": "int64" - }, - "maxDataPoints": { - "description": "TODO docs", - "type": "number" - }, - "thresholds": { - "description": "TODO docs - seems to be an old field from old dashboard alerts?", - "type": "array", - "items": {} - }, - "timeRegions": { - "description": "TODO docs", - "type": "array", - "items": {} - }, - "transformations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataTransformerConfig" - } - }, - "interval": { - "description": "TODO docs\nTODO tighter constraint", - "type": "string" - }, - "timeFrom": { - "description": "TODO docs\nTODO tighter constraint", - "type": "string" - }, - "timeShift": { - "description": "TODO docs\nTODO tighter constraint", - "type": "string" - }, - "libraryPanel": { - "$ref": "#/components/schemas/LibraryPanelRef" - }, - "options": { - "description": "options is specified by the PanelOptions field in panel\nplugin schemas.", - "type": "object" - }, - "fieldConfig": { - "$ref": "#/components/schemas/FieldConfigSource" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RangeMap": { - "description": "TODO docs", - "type": "object", - "required": [ - "type", - "options" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MappingType" - }, - { - "enum": [ - "range" - ] - } - ] - }, - "options": { - "type": "object", - "required": [ - "from", - "to", - "result" - ], - "properties": { - "from": { - "description": "to and from are `number | null` in current ts, really not sure what to do", - "type": "number", - "format": "double" - }, - "to": { - "type": "number", - "format": "double" - }, - "result": { - "$ref": "#/components/schemas/ValueMappingResult" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RegexMap": { - "description": "TODO docs", - "type": "object", - "required": [ - "type", - "options" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MappingType" - }, - { - "enum": [ - "regex" - ] - } - ] - }, - "options": { - "type": "object", - "required": [ - "pattern", - "result" - ], - "properties": { - "pattern": { - "type": "string" - }, - "result": { - "$ref": "#/components/schemas/ValueMappingResult" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RowPanel": { - "description": "Row panel", - "type": "object", - "required": [ - "type", - "collapsed", - "id", - "panels" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "row" - ] - }, - "collapsed": { - "type": "boolean", - "default": false - }, - "title": { - "type": "string" - }, - "datasource": { - "description": "Name of default datasource.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "uid": { - "type": "string" - } - } - }, - "gridPos": { - "$ref": "#/components/schemas/GridPos" - }, - "id": { - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "panels": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/Panel" - }, - { - "$ref": "#/components/schemas/GraphPanel" - }, - { - "$ref": "#/components/schemas/HeatmapPanel" - } - ] - } - }, - "repeat": { - "description": "Name of template variable to repeat for.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Snapshot": { - "description": "TODO docs", - "type": "object", - "required": [ - "created", - "expires", - "external", - "externalUrl", - "id", - "key", - "name", - "orgId", - "updated", - "userId" - ], - "properties": { - "created": { - "description": "TODO docs", - "type": "string", - "format": "date-time" - }, - "expires": { - "description": "TODO docs", - "type": "string" - }, - "external": { - "description": "TODO docs", - "type": "boolean" - }, - "externalUrl": { - "description": "TODO docs", - "type": "string" - }, - "id": { - "description": "TODO docs", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "key": { - "description": "TODO docs", - "type": "string" - }, - "name": { - "description": "TODO docs", - "type": "string" - }, - "orgId": { - "description": "TODO docs", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "updated": { - "description": "TODO docs", - "type": "string", - "format": "date-time" - }, - "url": { - "description": "TODO docs", - "type": "string" - }, - "userId": { - "description": "TODO docs", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SpecialValueMap": { - "description": "TODO docs", - "type": "object", - "required": [ - "type", - "options" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MappingType" - }, - { - "enum": [ - "special" - ] - } - ] - }, - "options": { - "type": "object", - "required": [ - "match", - "pattern", - "result" - ], - "properties": { - "match": { - "type": "string", - "enum": [ - "true", - "false" - ] - }, - "pattern": { - "type": "string" - }, - "result": { - "$ref": "#/components/schemas/ValueMappingResult" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SpecialValueMatch": { - "description": "TODO docs", - "type": "string", - "enum": [ - "true", - "false", - "null", - "nan", - "null+nan", - "empty" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Target": { - "description": "Schema for panel targets is specified by datasource\nplugins. We use a placeholder definition, which the Go\nschema loader either left open/as-is with the Base\nvariant of the Dashboard and Panel families, or filled\nwith types derived from plugins in the Instance variant.\nWhen working directly from CUE, importers can extend this\ntype directly to achieve the same effect.", - "type": "object", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Threshold": { - "description": "TODO docs", - "type": "object", - "required": [ - "color" - ], - "properties": { - "value": { - "description": "TODO docs\nFIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON", - "type": "number" - }, - "color": { - "description": "TODO docs", - "type": "string" - }, - "index": { - "description": "Threshold index, an old property that is not needed an should only appear in older dashboards", - "type": "integer", - "format": "int32" - }, - "state": { - "description": "TODO docs\nTODO are the values here enumerable into a disjunction?\nSome seem to be listed in typescript comment", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ThresholdsConfig": { - "type": "object", - "required": [ - "mode", - "steps" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/ThresholdsMode" - }, - "steps": { - "description": "Must be sorted by 'value', first value is always -Infinity", - "type": "array", - "items": { - "$ref": "#/components/schemas/Threshold" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ThresholdsMode": { - "type": "string", - "enum": [ - "absolute", - "percentage" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ValueMap": { - "description": "TODO docs", - "type": "object", - "required": [ - "type", - "options" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MappingType" - }, - { - "enum": [ - "value" - ] - } - ] - }, - "options": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ValueMappingResult" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ValueMapping": { - "description": "TODO docs", - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/ValueMap" - }, - { - "$ref": "#/components/schemas/RangeMap" - }, - { - "$ref": "#/components/schemas/RegexMap" - }, - { - "$ref": "#/components/schemas/SpecialValueMap" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ValueMappingResult": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "color": { - "type": "string" - }, - "icon": { - "type": "string" - }, - "index": { - "type": "integer", - "format": "int32" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VariableHide": { - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VariableModel": { - "description": "FROM: packages/grafana-data/src/types/templateVars.ts\nTODO docs\nTODO what about what's in public/app/features/types.ts?\nTODO there appear to be a lot of different kinds of [template] vars here? if so need a disjunction", - "type": "object", - "required": [ - "id", - "type", - "name", - "global", - "hide", - "skipUrlSync", - "index", - "state" - ], - "properties": { - "id": { - "type": "string", - "default": "00000000-0000-0000-0000-000000000000" - }, - "type": { - "$ref": "#/components/schemas/VariableType" - }, - "name": { - "type": "string" - }, - "label": { - "type": "string" - }, - "rootStateKey": { - "type": "string" - }, - "global": { - "type": "boolean", - "default": false - }, - "hide": { - "$ref": "#/components/schemas/VariableHide" - }, - "skipUrlSync": { - "type": "boolean", - "default": false - }, - "index": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647, - "default": -1 - }, - "state": { - "$ref": "#/components/schemas/LoadingState" - }, - "error": { - "type": "object" - }, - "description": { - "type": "string" - }, - "query": { - "description": "TODO: Move this into a separated QueryVariableModel type", - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "datasource": { - "$ref": "#/components/schemas/DataSourceRef" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VariableType": { - "description": "FROM: packages/grafana-data/src/types/templateVars.ts\nTODO docs\nTODO this implies some wider pattern/discriminated union, probably?", - "type": "string", - "enum": [ - "query", - "adhoc", - "constant", - "datasource", - "interval", - "textbox", - "custom", - "system" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "dashboard": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "style", - "editable", - "graphTooltip", - "schemaVersion" - ], - "properties": { - "id": { - "description": "Unique numeric identifier for the dashboard.\nTODO must isolate or remove identifiers local to a Grafana instance...?", - "type": "integer", - "format": "int64" - }, - "uid": { - "description": "Unique dashboard identifier that can be generated by anyone. string (8-40)", - "type": "string" - }, - "title": { - "description": "Title of dashboard.", - "type": "string" - }, - "description": { - "description": "Description of dashboard.", - "type": "string" - }, - "revision": { - "description": "This property should only be used in dashboards defined by plugins. It is a quick check\nto see if the version has changed since the last time. Unclear why using the version property\nis insufficient.", - "type": "integer", - "format": "int64" - }, - "gnetId": { - "description": "For dashboards imported from the https://grafana.com/grafana/dashboards/ portal", - "type": "string" - }, - "tags": { - "description": "Tags associated with dashboard.", - "type": "array", - "items": { - "type": "string" - } - }, - "style": { - "description": "Theme of dashboard.", - "type": "string", - "enum": [ - "dark", - "light" - ], - "default": "dark" - }, - "timezone": { - "description": "Timezone of dashboard. Accepts IANA TZDB zone ID or \"browser\" or \"utc\".", - "type": "string", - "default": "browser" - }, - "editable": { - "description": "Whether a dashboard is editable or not.", - "type": "boolean", - "default": true - }, - "graphTooltip": { - "$ref": "#/components/schemas/DashboardCursorSync" - }, - "time": { - "description": "Time range for dashboard, e.g. last 6 hours, last 7 days, etc", - "type": "object", - "required": [ - "from", - "to" - ], - "properties": { - "from": { - "type": "string", - "default": "now-6h" - }, - "to": { - "type": "string", - "default": "now" - } - } - }, - "timepicker": { - "description": "TODO docs\nTODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes", - "type": "object", - "required": [ - "collapse", - "enable", - "hidden", - "refresh_intervals", - "time_options" - ], - "properties": { - "collapse": { - "description": "Whether timepicker is collapsed or not.", - "type": "boolean", - "default": false - }, - "enable": { - "description": "Whether timepicker is enabled or not.", - "type": "boolean", - "default": true - }, - "hidden": { - "description": "Whether timepicker is visible or not.", - "type": "boolean", - "default": false - }, - "refresh_intervals": { - "description": "Selectable intervals for auto-refresh.", - "type": "array", - "items": { - "type": "string" - }, - "default": [ - "5s", - "10s", - "30s", - "1m", - "5m", - "15m", - "30m", - "1h", - "2h", - "1d" - ] - }, - "time_options": { - "description": "TODO docs", - "type": "array", - "items": { - "type": "string" - }, - "default": [ - "5m", - "15m", - "1h", - "6h", - "12h", - "24h", - "2d", - "7d", - "30d" - ] - } - } - }, - "fiscalYearStartMonth": { - "description": "The month that the fiscal year starts on. 0 = January, 11 = December", - "type": "integer", - "minimum": 0, - "maximum": 12, - "exclusiveMaximum": true, - "default": 0 - }, - "liveNow": { - "description": "When set to true, the dashboard will redraw panels at an interval matching the pixel width.\nThis will keep data \"moving left\" regardless of the query refresh rate. This setting helps\navoid dashboards presenting stale live data", - "type": "boolean" - }, - "weekStart": { - "description": "TODO docs", - "type": "string" - }, - "refresh": { - "description": "Refresh rate of dashboard. Represented via interval string, e.g. \"5s\", \"1m\", \"1h\", \"1d\".", - "oneOf": [ - { - "enum": [ - false - ] - }, - { - "type": "string" - } - ] - }, - "schemaVersion": { - "description": "Version of the JSON schema, incremented each time a Grafana update brings\nchanges to said schema.\nTODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion", - "type": "integer", - "minimum": 0, - "maximum": 65535, - "default": 36 - }, - "version": { - "description": "Version of the dashboard, incremented each time the dashboard is updated.", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "panels": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/Panel" - }, - { - "$ref": "#/components/schemas/RowPanel" - }, - { - "$ref": "#/components/schemas/GraphPanel" - }, - { - "$ref": "#/components/schemas/HeatmapPanel" - } - ] - } - }, - "templating": { - "description": "TODO docs", - "type": "object", - "properties": { - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VariableModel" - } - } - } - }, - "annotations": { - "$ref": "#/components/schemas/AnnotationContainer" - }, - "links": { - "description": "TODO docs", - "type": "array", - "items": { - "$ref": "#/components/schemas/DashboardLink" - } - }, - "snapshot": { - "$ref": "#/components/schemas/Snapshot" - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/librarypanel/x/librarypanel_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/librarypanel/x/librarypanel_types_gen.json deleted file mode 100644 index 9b63581..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/librarypanel/x/librarypanel_types_gen.json +++ /dev/null @@ -1,298 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "librarypanel", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "LibraryElementDTOMeta": { - "type": "object", - "required": [ - "folderName", - "folderUid", - "connectedDashboards", - "created", - "updated", - "createdBy", - "updatedBy" - ], - "properties": { - "folderName": { - "type": "string" - }, - "folderUid": { - "type": "string" - }, - "connectedDashboards": { - "type": "integer", - "format": "int64" - }, - "created": { - "type": "string", - "format": "date-time" - }, - "updated": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "$ref": "#/components/schemas/LibraryElementDTOMetaUser" - }, - "updatedBy": { - "$ref": "#/components/schemas/LibraryElementDTOMetaUser" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LibraryElementDTOMetaUser": { - "type": "object", - "required": [ - "id", - "name", - "avatarUrl" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "avatarUrl": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "librarypanel": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "uid", - "name", - "type", - "version", - "model" - ], - "properties": { - "folderUid": { - "description": "Folder UID", - "type": "string" - }, - "uid": { - "description": "Library element UID", - "type": "string" - }, - "name": { - "description": "Panel name (also saved in the model)", - "type": "string", - "minLength": 1 - }, - "description": { - "description": "Panel description", - "type": "string" - }, - "type": { - "description": "The panel type (from inside the model)", - "type": "string", - "minLength": 1 - }, - "schemaVersion": { - "description": "Dashboard version when this was saved (zero if unknown)", - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "version": { - "description": "panel version, incremented each time the dashboard is updated.", - "type": "integer", - "format": "int64" - }, - "model": { - "description": "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit\u003cPanel, 'gridPos' | 'id' | 'libraryPanel'\u003e;", - "type": "object" - }, - "meta": { - "$ref": "#/components/schemas/LibraryElementDTOMeta" - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/playlist/x/playlist_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/playlist/x/playlist_types_gen.json deleted file mode 100644 index 5b8f327..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/playlist/x/playlist_types_gen.json +++ /dev/null @@ -1,243 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "playlist", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "PlaylistItem": { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "description": "Type of the item.", - "type": "string", - "enum": [ - "dashboard_by_uid", - "dashboard_by_id", - "dashboard_by_tag" - ] - }, - "value": { - "description": "Value depends on type and describes the playlist item.\n\n - dashboard_by_id: The value is an internal numerical identifier set by Grafana. This\n is not portable as the numerical identifier is non-deterministic between different instances.\n Will be replaced by dashboard_by_uid in the future. (deprecated)\n - dashboard_by_tag: The value is a tag which is set on any number of dashboards. All\n dashboards behind the tag will be added to the playlist.\n - dashboard_by_uid: The value is the dashboard UID", - "type": "string" - }, - "title": { - "description": "Title is an unused property -- it will be removed in the future", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "playlist": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "uid", - "name", - "interval" - ], - "properties": { - "uid": { - "description": "Unique playlist identifier. Generated on creation, either by the\ncreator of the playlist of by the application.", - "type": "string" - }, - "name": { - "description": "Name of the playlist.", - "type": "string" - }, - "interval": { - "description": "Interval sets the time between switching views in a playlist.\nFIXME: Is this based on a standardized format or what options are available? Can datemath be used?", - "type": "string", - "default": "5m" - }, - "items": { - "description": "The ordered list of items that the playlist will iterate over.\nFIXME! This should not be optional, but changing it makes the godegen awkward", - "type": "array", - "items": { - "$ref": "#/components/schemas/PlaylistItem" - } - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/preferences/x/preferences_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/preferences/x/preferences_types_gen.json deleted file mode 100644 index 692bfeb..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/preferences/x/preferences_types_gen.json +++ /dev/null @@ -1,224 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "preferences", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "QueryHistoryPreference": { - "type": "object", - "properties": { - "homeTab": { - "description": "one of: '' | 'query' | 'starred';", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "preferences": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "properties": { - "homeDashboardUID": { - "description": "UID for the home dashboard", - "type": "string" - }, - "timezone": { - "description": "The timezone selection\nTODO: this should use the timezone defined in common", - "type": "string" - }, - "weekStart": { - "description": "day of the week (sunday, monday, etc)", - "type": "string" - }, - "theme": { - "description": "light, dark, empty is default", - "type": "string" - }, - "language": { - "description": "Selected language (beta)", - "type": "string" - }, - "queryHistory": { - "$ref": "#/components/schemas/QueryHistoryPreference" - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/publicdashboard/x/publicdashboard_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/publicdashboard/x/publicdashboard_types_gen.json deleted file mode 100644 index 1422bfa..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/publicdashboard/x/publicdashboard_types_gen.json +++ /dev/null @@ -1,222 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "publicdashboard", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "publicdashboard": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "uid", - "dashboardUid", - "isEnabled", - "annotationsEnabled", - "timeSelectionEnabled" - ], - "properties": { - "uid": { - "description": "Unique public dashboard identifier", - "type": "string" - }, - "dashboardUid": { - "description": "Dashboard unique identifier referenced by this public dashboard", - "type": "string" - }, - "accessToken": { - "description": "Unique public access token", - "type": "string" - }, - "isEnabled": { - "description": "Flag that indicates if the public dashboard is enabled", - "type": "boolean" - }, - "annotationsEnabled": { - "description": "Flag that indicates if annotations are enabled", - "type": "boolean" - }, - "timeSelectionEnabled": { - "description": "Flag that indicates if the time range picker is enabled", - "type": "boolean" - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/serviceaccount/x/serviceaccount_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/serviceaccount/x/serviceaccount_types_gen.json deleted file mode 100644 index f8d0fca..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/serviceaccount/x/serviceaccount_types_gen.json +++ /dev/null @@ -1,259 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "serviceaccount", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "OrgRole": { - "description": "OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'.", - "type": "string", - "enum": [ - "Admin", - "Editor", - "Viewer" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "serviceaccount": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "id", - "orgId", - "name", - "login", - "isDisabled", - "role", - "tokens", - "avatarUrl" - ], - "properties": { - "id": { - "description": "ID is the unique identifier of the service account in the database.", - "type": "integer", - "format": "int64" - }, - "orgId": { - "description": "OrgId is the ID of an organisation the service account belongs to.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "Name of the service account.", - "type": "string" - }, - "login": { - "description": "Login of the service account.", - "type": "string" - }, - "isDisabled": { - "description": "IsDisabled indicates if the service account is disabled.", - "type": "boolean" - }, - "role": { - "$ref": "#/components/schemas/OrgRole" - }, - "tokens": { - "description": "Tokens is the number of active tokens for the service account.\nTokens are used to authenticate the service account against Grafana.", - "type": "integer", - "format": "int64" - }, - "avatarUrl": { - "description": "AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front\nof the service account.", - "type": "string" - }, - "accessControl": { - "description": "AccessControl metadata associated with a given resource.", - "type": "object", - "additionalProperties": { - "type": "boolean" - } - }, - "teams": { - "description": "Teams is a list of teams the service account belongs to.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/team/x/team_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/team/x/team_types_gen.json deleted file mode 100644 index c782be8..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/team/x/team_types_gen.json +++ /dev/null @@ -1,239 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "team", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "Permission": { - "type": "integer", - "enum": [ - 0, - 1, - 2, - 4 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "team": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "orgId", - "name", - "memberCount", - "permission" - ], - "properties": { - "orgId": { - "description": "OrgId is the ID of an organisation the team belongs to.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "Name of the team.", - "type": "string" - }, - "email": { - "description": "Email of the team.", - "type": "string" - }, - "avatarUrl": { - "description": "AvatarUrl is the team's avatar URL.", - "type": "string" - }, - "memberCount": { - "description": "MemberCount is the number of the team members.", - "type": "integer", - "format": "int64" - }, - "permission": { - "$ref": "#/components/schemas/Permission" - }, - "accessControl": { - "description": "AccessControl metadata associated with a given resource.", - "type": "object", - "additionalProperties": { - "type": "boolean" - } - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/jsonnet-libs/grizzly/README.md b/vendor/github.com/grafana/jsonnet-libs/grizzly/README.md new file mode 100644 index 0000000..b503289 --- /dev/null +++ b/vendor/github.com/grafana/jsonnet-libs/grizzly/README.md @@ -0,0 +1,23 @@ +# Grizzly Library + +This library provides utilities for [Grizzly](https://github.com/grafana/grizzly), +a utility for managing observability resources on Grafana and hosted Prometheus +installations. + +## Kubernetes Style Observability Objects +It provides functions to render Kubernetes style objects from Monitoring Mixins. + +If deploying dashboards structured to be consumed by [prometheus-ksonnet](https://github.com/grafana/jsonnet-libs/prometheus-ksonnet) +or associated libraries, where other resources are using Tanka, place a file +named `grr.jsonnet` next to your `main.jsonnet`, and give it this content: + +``` +local main = (import 'main.jsonnet'); +local grizzly = (import 'grizzly/grizzly.libsonnet'); + +grizzly.fromPrometheusKsonnet(main) +``` + +Then, you can invoke this from Grizzly like so: + +`grr show -r environments//grr.libsonnet` diff --git a/vendor/github.com/grafana/jsonnet-libs/grizzly/check.libsonnet b/vendor/github.com/grafana/jsonnet-libs/grizzly/check.libsonnet new file mode 100644 index 0000000..a1ff9ef --- /dev/null +++ b/vendor/github.com/grafana/jsonnet-libs/grizzly/check.libsonnet @@ -0,0 +1,7 @@ +local resource = import 'resource.libsonnet'; +{ + new(type, name, check):: + resource.new('SyntheticMonitoringCheck', name) + + resource.addMetadata('type', type) + + resource.withSpec(check), +} diff --git a/vendor/github.com/grafana/jsonnet-libs/grizzly/grafana.libsonnet b/vendor/github.com/grafana/jsonnet-libs/grizzly/grafana.libsonnet new file mode 100644 index 0000000..ab555d9 --- /dev/null +++ b/vendor/github.com/grafana/jsonnet-libs/grizzly/grafana.libsonnet @@ -0,0 +1,52 @@ +local resource = import 'resource.libsonnet'; +local util = import 'util.libsonnet'; + +{ + getFolder(main):: util.get(main, 'grafanaDashboardFolder', 'General'), + + fromMap(dashboards, folder):: { + [k]: util.makeResource( + 'Dashboard', + std.strReplace(std.strReplace(std.strReplace(k, '.json', ''), '.yaml', ''), '.yml', ''), + dashboards[k], + { folder: folder } + ) + for k in std.objectFields(dashboards) + }, + + fromMixins(mixins):: { + [key]: + local mixin = mixins[key]; + { + local folder = util.get(mixin, 'grafanaDashboardFolder', 'General'), + [k]: util.makeResource( + 'Dashboard', + std.strReplace(std.strReplace(std.strReplace(k, '.json', ''), '.yaml', ''), '.yml', ''), + mixin.grafanaDashboards[k], + { folder: folder } + ) + for k in std.objectFieldsAll(util.get(mixin, 'grafanaDashboards', {})) + } + for key in std.objectFields(mixins) + }, + + dashboard: { + new(name, dashboard_json):: + resource.new('Dashboard', name) + + resource.withSpec(dashboard_json), + }, + + folder: { + new(name, title):: + resource.new('DashboardFolder', name) + + resource.withSpec({ + title: title, + }), + }, + + datasource: { + new(name, datasource_json):: + resource.new('Datasource', name) + + resource.withSpec(datasource_json), + }, +} diff --git a/vendor/github.com/grafana/jsonnet-libs/grizzly/grizzly.libsonnet b/vendor/github.com/grafana/jsonnet-libs/grizzly/grizzly.libsonnet new file mode 100644 index 0000000..a139517 --- /dev/null +++ b/vendor/github.com/grafana/jsonnet-libs/grizzly/grizzly.libsonnet @@ -0,0 +1,26 @@ +local grafana = import 'grafana.libsonnet'; +local prometheus = import 'prometheus.libsonnet'; +{ + grafana: grafana, + prometheus: prometheus, + + fromPrometheusKsonnet(main):: { + local dashboardFolder = grafana.getFolder(main), + local mixinRules = prometheus.getMixinRuleNames(main.mixins), + + grafana: grafana.fromMap(main.grafanaDashboards, dashboardFolder) + + grafana.fromMixins(main.mixins), + + prometheus: prometheus.fromMapsFiltered(main.prometheusAlerts, mixinRules) + + prometheus.fromMapsFiltered(main.prometheusRules, mixinRules) + + prometheus.fromMixins(main.mixins), + }, + + resource: (import 'resource.libsonnet'), + dashboard: grafana.dashboard, + folder: grafana.folder, + datasource: grafana.datasource, + rule_group: prometheus.rule_group, + synthetic_monitoring_check: (import 'check.libsonnet'), + +} diff --git a/vendor/github.com/grafana/jsonnet-libs/grizzly/prometheus.libsonnet b/vendor/github.com/grafana/jsonnet-libs/grizzly/prometheus.libsonnet new file mode 100644 index 0000000..90e75ff --- /dev/null +++ b/vendor/github.com/grafana/jsonnet-libs/grizzly/prometheus.libsonnet @@ -0,0 +1,44 @@ +local util = import 'util.libsonnet'; +local kind = 'PrometheusRuleGroup'; +local recordingRules = 'prometheusRules'; +local alertRules = 'prometheusAlerts'; +local resource = import 'resource.libsonnet'; + +{ + getMixinRuleNames(mixins):: + local flatMixins = [mixins[key] for key in std.objectFieldsAll(mixins)]; + local mixinRules = std.flattenArrays([mixin.prometheusRules.groups for mixin in flatMixins if std.objectHasAll(mixin, recordingRules)]); + local mixinAlerts = std.flattenArrays([mixin.prometheusAlerts.groups for mixin in flatMixins if std.objectHasAll(mixin, alertRules)]); + [group.name for group in mixinAlerts] + [group.name for group in mixinRules], + + fromMaps(rules):: { [k]: util.makeResource(kind, k, { groups: rules }, {}) for k in std.objectFields(rules) }, + + fromMapsFiltered(rules, excludes):: { + local filterRules(rules, exclude_list) = [rule for rule in rules.groups if !std.member(exclude_list, rule.name)], + [k]: util.makeResource( + kind, + std.strReplace(std.strReplace(std.strReplace(k, '.json', ''), '.yaml', ''), '.yml', ''), + { groups: filterRules(rules, excludes) }, + {} + ) + for k in std.objectFields(rules) + }, + + fromMixins(mixins):: { + [if std.objectHasAll(mixins[key], alertRules) || std.objectHasAll(mixins[key], recordingRules) then key else null]: + util.makeResource( + kind, + std.strReplace(std.strReplace(std.strReplace(key, '.json', ''), '.yaml', ''), '.yml', ''), + (if std.objectHasAll(mixins[key], alertRules) then mixins[key].prometheusAlerts else {}) + + (if std.objectHasAll(mixins[key], recordingRules) then mixins[key].prometheusRules else {}) + ) + for key in std.objectFields(mixins) + }, + + rule_group: { + new(namespace, name, group):: + resource.new('PrometheusRuleGroup', name) + + resource.addMetadata('namespace', namespace) + + resource.withSpec(group), + }, +} diff --git a/vendor/github.com/grafana/jsonnet-libs/grizzly/resource.libsonnet b/vendor/github.com/grafana/jsonnet-libs/grizzly/resource.libsonnet new file mode 100644 index 0000000..9f6054a --- /dev/null +++ b/vendor/github.com/grafana/jsonnet-libs/grizzly/resource.libsonnet @@ -0,0 +1,22 @@ +{ + defaultApiVersion:: 'grizzly.grafana.com/v1alpha1', + new(kind, name):: { + apiVersion: $.defaultApiVersion, + kind: kind, + metadata: { + name: name, + }, + }, + withApiVersion(apiVersion):: { + defaultApiVersion:: apiVersion, + apiVersion: apiVersion, + }, + addMetadata(name, value):: { + metadata+: { + [name]: value, + }, + }, + withSpec(spec):: { + spec: spec, + }, +} diff --git a/vendor/github.com/grafana/jsonnet-libs/grizzly/util.libsonnet b/vendor/github.com/grafana/jsonnet-libs/grizzly/util.libsonnet new file mode 100644 index 0000000..5559a8c --- /dev/null +++ b/vendor/github.com/grafana/jsonnet-libs/grizzly/util.libsonnet @@ -0,0 +1,13 @@ +{ + grizzlyAPI:: 'grizzly.grafana.com/v1alpha1', + get(obj, key, default):: if std.objectHasAll(obj, key) then obj[key] else default, + + makeResource(kind, name, resource, metadata={}):: { + apiVersion: $.grizzlyAPI, + kind: kind, + metadata: { + name: name, + } + metadata, + spec: resource, + }, +} diff --git a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md index aa19a25..c677742 100644 --- a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md +++ b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md @@ -3,7 +3,6 @@ `doc-util` provides a Jsonnet interface for `docsonnet`, a Jsonnet API doc generator that uses structured data instead of comments. - ## Install ``` @@ -16,6 +15,7 @@ jb install github.com/jsonnet-libs/docsonnet/doc-util@master local d = import "github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet" ``` + ## Index * [`fn arg(name, type, default, enums)`](#fn-arg) @@ -25,6 +25,7 @@ local d = import "github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet" * [`fn render(obj)`](#fn-render) * [`fn val(type, help, default)`](#fn-val) * [`obj argument`](#obj-argument) + * [`fn fromSchema(name, schema)`](#fn-argumentfromschema) * [`fn new(name, type, default, enums)`](#fn-argumentnew) * [`obj func`](#obj-func) * [`fn new(help, args)`](#fn-funcnew) @@ -44,42 +45,69 @@ local d = import "github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet" ### fn arg -```ts +```jsonnet arg(name, type, default, enums) ``` -`arg` is a shorthand for `argument.new` +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **default** (`any`) +* **enums** (`array`) +`arg` is a shorthand for `argument.new` ### fn fn -```ts +```jsonnet fn(help, args) ``` -`fn` is a shorthand for `func.new` +PARAMETERS: +* **help** (`string`) +* **args** (`array`) + +`fn` is a shorthand for `func.new` ### fn obj -```ts +```jsonnet obj(help, fields) ``` -`obj` is a shorthand for `object.new` +PARAMETERS: + +* **help** (`string`) +* **fields** (`object`) +`obj` is a shorthand for `object.new` ### fn pkg -```ts +```jsonnet pkg(name, url, help, filename="", version="master") ``` -`new` is a shorthand for `package.new` +PARAMETERS: + +* **name** (`string`) +* **url** (`string`) +* **help** (`string`) +* **filename** (`string`) + - default value: `""` +* **version** (`string`) + - default value: `"master"` +`new` is a shorthand for `package.new` ### fn render -```ts +```jsonnet render(obj) ``` +PARAMETERS: + +* **obj** (`object`) + `render` converts the docstrings to human readable Markdown files. Usage: @@ -91,25 +119,59 @@ d.render(import 'main.libsonnet') Call with: `jsonnet -S -c -m docs/ docs.jsonnet` - ### fn val -```ts +```jsonnet val(type, help, default) ``` -`val` is a shorthand for `value.new` +PARAMETERS: + +* **type** (`string`) +* **help** (`string`) +* **default** (`any`) +`val` is a shorthand for `value.new` ### obj argument Utilities for creating function arguments +#### fn argument.fromSchema + +```jsonnet +argument.fromSchema(name, schema) +``` + +PARAMETERS: + +* **name** (`string`) +* **schema** (`object`) + +`fromSchema` creates a new function argument, taking a JSON `schema` to describe the type information for this argument. + +Examples: + +```jsonnet +[ + d.argument.fromSchema('foo', { type: 'string' }), + d.argument.fromSchema('bar', { type: 'string', default='loo' }), + d.argument.fromSchema('baz', { type: 'number', enum=[1,2,3] }), +] +``` + #### fn argument.new -```ts -new(name, type, default, enums) +```jsonnet +argument.new(name, type, default, enums) ``` +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **default** (`any`) +* **enums** (`array`) + `new` creates a new function argument, taking the `name`, the `type`. Optionally it can take a `default` value and `enum`-erate potential values. @@ -123,69 +185,89 @@ Examples: ] ``` - ### obj func Utilities for documenting Jsonnet methods (functions of objects) #### fn func.new -```ts -new(help, args) +```jsonnet +func.new(help, args) ``` -new creates a new function, optionally with description and arguments +PARAMETERS: + +* **help** (`string`) +* **args** (`array`) +new creates a new function, optionally with description and arguments #### fn func.withArgs -```ts -withArgs(args) +```jsonnet +func.withArgs(args) ``` -The `withArgs` modifier overrides the arguments of that function +PARAMETERS: + +* **args** (`array`) +The `withArgs` modifier overrides the arguments of that function #### fn func.withHelp -```ts -withHelp(help) +```jsonnet +func.withHelp(help) ``` -The `withHelp` modifier overrides the help text of that function +PARAMETERS: +* **help** (`string`) + +The `withHelp` modifier overrides the help text of that function ### obj object Utilities for documenting Jsonnet objects (`{ }`). #### fn object.new -```ts -new(help, fields) +```jsonnet +object.new(help, fields) ``` -new creates a new object, optionally with description and fields +PARAMETERS: +* **help** (`string`) +* **fields** (`object`) + +new creates a new object, optionally with description and fields #### fn object.withFields -```ts -withFields(fields) +```jsonnet +object.withFields(fields) ``` -The `withFields` modifier overrides the fields property of an already created object +PARAMETERS: + +* **fields** (`object`) +The `withFields` modifier overrides the fields property of an already created object ### obj value Utilities for documenting plain Jsonnet values (primitives) #### fn value.new -```ts -new(type, help, default) +```jsonnet +value.new(type, help, default) ``` -new creates a new object of given type, optionally with description and default value +PARAMETERS: -### obj T +* **type** (`string`) +* **help** (`string`) +* **default** (`any`) +new creates a new object of given type, optionally with description and default value +### obj T * `T.any` (`string`): `"any"` - argument of type "any" * `T.array` (`string`): `"array"` - argument of type "array" @@ -201,10 +283,20 @@ new creates a new object of given type, optionally with description and default #### fn package.new -```ts -new(name, url, help, filename="", version="master") +```jsonnet +package.new(name, url, help, filename="", version="master") ``` +PARAMETERS: + +* **name** (`string`) +* **url** (`string`) +* **help** (`string`) +* **filename** (`string`) + - default value: `""` +* **version** (`string`) + - default value: `"master"` + `new` creates a new package Arguments: @@ -215,17 +307,20 @@ Arguments: * `filename` for the import, defaults to blank for backward compatibility * `version` for jsonnet-bundler install, defaults to `master` just like jsonnet-bundler - #### fn package.newSub -```ts -newSub(name, help) +```jsonnet +package.newSub(name, help) ``` +PARAMETERS: + +* **name** (`string`) +* **help** (`string`) + `newSub` creates a package without the preconfigured install/usage templates. Arguments: * given `name` * `help` text - diff --git a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet index f47c83d..f3ec298 100644 --- a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet +++ b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet @@ -36,7 +36,10 @@ new(name, url, help, filename='', version='master'):: { name: name, - help: help, + help: + help + + std.get(self, 'installTemplate', '') % self + + std.get(self, 'usageTemplate', '') % self, 'import': if filename != '' then url + '/' + filename @@ -70,12 +73,34 @@ help: help, }, - withUsageTemplate(template):: { - usageTemplate: template, + withInstallTemplate(template):: { + installTemplate: + if template != null + then + ||| + + ## Install + + ``` + %s + ``` + ||| % template + else '', }, - withInstallTemplate(template):: { - installTemplate: template, + withUsageTemplate(template):: { + usageTemplate: + if template != null + then + ||| + + ## Usage + + ```jsonnet + %s + ``` + ||| % template + else '', }, }, @@ -148,6 +173,26 @@ default: default, enums: enums, }, + '#fromSchema': d.fn(||| + `fromSchema` creates a new function argument, taking a JSON `schema` to describe the type information for this argument. + + Examples: + + ```jsonnet + [ + d.argument.fromSchema('foo', { type: 'string' }), + d.argument.fromSchema('bar', { type: 'string', default='loo' }), + d.argument.fromSchema('baz', { type: 'number', enum=[1,2,3] }), + ] + ``` + |||, [ + d.arg('name', d.T.string), + d.arg('schema', d.T.object), + ]), + fromSchema(name, schema): { + name: name, + schema: schema, + }, }, '#arg': self.argument['#new'] + self.func.withHelp('`arg` is a shorthand for `argument.new`'), arg:: self.argument.new, diff --git a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet index 0c620c3..758b033 100644 --- a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet +++ b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet @@ -1,401 +1,479 @@ { local root = self, - templates: { - package: ||| - # %(name)s - - %(content)s - |||, + render(obj): + assert std.isObject(obj) && '#' in obj : 'error: object is not a docsonnet package'; + local package = self.package(obj); + package.toFiles(), + + findPackages(obj, path=[]): { + local find(obj, path, parentWasPackage=true) = + std.foldl( + function(acc, k) + acc + + ( + // If matches a package but warn if also has an object docstring + if '#' in obj[k] && '#' + k in obj + && !std.objectHasAll(obj[k]['#'], 'ignore') + then std.trace( + 'warning: %s both defined as object and package' % k, + [root.package(obj[k], path + [k], parentWasPackage)] + ) + // If matches a package, return it + else if '#' in obj[k] + && !std.objectHasAll(obj[k]['#'], 'ignore') + then [root.package(obj[k], path + [k], parentWasPackage)] + // If not, keep looking + else find(obj[k], path + [k], parentWasPackage=false) + ), + std.filter( + function(k) + !std.startsWith(k, '#') + && std.isObject(obj[k]), + std.objectFieldsAll(obj) + ), + [] + ), - indexPage: ||| - # %(prefix)s%(name)s + packages: find(obj, path), - %(index)s - |||, + hasPackages(): std.length(self.packages) > 0, - index: ||| - ## Index + toIndex(relativeTo=[]): + if self.hasPackages() + then + std.join('\n', [ + '* ' + p.link(relativeTo) + for p in self.packages + ]) + + '\n' + else '', + + toFiles(): + std.foldl( + function(acc, p) + acc + + { [p.path]: p.toString() } + + p.packages.toFiles(), + self.packages, + {} + ), + }, - %s - |||, + package(obj, path=[], parentWasPackage=true): { + local this = self, + local doc = obj['#'], + + packages: root.findPackages(obj, path), + fields: root.fields(obj), + + local pathsuffix = + (if self.packages.hasPackages() + then '/index.md' + else '.md'), + + // filepath on disk + path: + std.join('/', path) + + pathsuffix, + + link(relativeTo): + local relativepath = root.util.getRelativePath(path, relativeTo); + '[%s](%s)' % [ + std.join('.', relativepath), + std.join('/', relativepath) + + pathsuffix, + ], - sectionTitle: '%(abbr)s %(prefix)s%(name)s', + toFiles(): + { 'README.md': this.toString() } + + self.packages.toFiles(), + + toString(): + std.join( + '\n', + [ + '# ' + doc.name + '\n', + std.get(doc, 'help', ''), + '', + ] + + (if self.packages.hasPackages() + then [ + '## Subpackages\n\n' + + self.packages.toIndex(path), + ] + else []) + + (if self.fields.hasFields() + then [ + '## Index\n\n' + + self.fields.toIndex() + + '\n## Fields\n' + + self.fields.toString(), + ] + else []) + ), + }, - sectionLink: '* [`%(abbr)s %(linkName)s`](#%(link)s)', + fields(obj, path=[]): { + values: root.findValues(obj, path), + functions: root.findFunctions(obj, path), + objects: root.findObjects(obj, path), - value: '* `%(prefix)s%(name)s` (`%(type)s`): `"%(value)s"` - %(help)s', + hasFields(): + std.any([ + self.values.hasFields(), + self.functions.hasFields(), + self.objects.hasFields(), + ]), - section: ||| - %(headerDepth)s %(title)s + toIndex(): + std.join('', [ + self.functions.toIndex(), + self.objects.toIndex(), + ]), - %(content)s - |||, + toString(): + std.join('', [ + self.values.toString(), + self.functions.toString(), + self.objects.toString(), + ]), }, - joinPathPrefixes(prefixes, sep='/'):: - std.join(sep, prefixes) - + (if std.length(prefixes) > 0 - then sep - else ''), - - joinPrefixes(prefixes, sep='.'):: - std.join(sep, prefixes) - + (if std.length(prefixes) > 0 - then sep - else ''), - - renderSectionTitle(section, prefixes):: - root.templates.sectionTitle % { - name: section.name, - abbr: section.type.abbr, - prefix: root.joinPrefixes(prefixes), - }, - - renderValues(values, prefixes=[]):: - if std.length(values) > 0 - then - std.join('\n', [ - root.templates.value - % value { - prefix: root.joinPrefixes(prefixes), - } - for value in values - ]) + '\n' - else '', - - renderSections(sections, depth=0, prefixes=[]):: - if std.length(sections) > 0 - then - std.join('\n', [ - root.templates.section - % { - headerDepth: std.join('', [ - '#' - for d in std.range(0, depth + 2) + findObjects(obj, path=[]): { + local keys = + std.filter( + root.util.filter('object', obj), + std.objectFieldsAll(obj) + ), + + local undocumentedKeys = + std.filter( + function(k) + std.all([ + !std.startsWith(k, '#'), + std.isObject(obj[k]), + !std.objectHasAll(obj[k], 'ignore'), + !('#' + k in obj), // not documented in parent + !('#' in obj[k]), // not a sub package ]), - title: root.renderSectionTitle( - section, - prefixes, - ), - content: section.content, - } - + root.renderValues( - section.values, - prefixes + [section.name] - ) - + root.renderSections( - section.subSections, - depth + 1, - prefixes + [section.name] - ) - for section in sections - ]) - else '', - - renderPackage(package, path=''):: - (root.templates.package % package) - + ( - if std.length(package.subPackages) > 0 - then - '## Subpackages\n\n' - + std.join('\n', [ - '* [%(name)s](%(path)s)' % { - name: sub.name, - path: path + sub.name - + (if std.length(sub.subPackages) > 0 - then '/index.md' - else '.md'), - } - for sub in package.subPackages - ]) + '\n\n' - else '' - ) - + (if std.length(package.sections) > 0 - then (root.templates.index % root.index(package.sections)) - else '') - + (if std.length(package.values) > 0 - || std.length(package.sections) > 0 - then - '\n## Fields\n\n' - + root.renderValues(package.values) - + root.renderSections(package.sections) - else ''), - - index(sections, depth=0, prefixes=[]):: - std.join('\n', [ - std.join('', [ - ' ' - for d in std.range(0, (depth * 2) - 1) - ]) - + (root.templates.sectionLink % { - abbr: section.type.abbr, - linkName: section.linkName, - link: - std.asciiLower( - std.strReplace( - std.strReplace(root.renderSectionTitle(section, prefixes), '.', '') - , ' ', '-' - ) - ), - }) - + ( - if std.length(section.subSections) > 0 - then '\n' + root.index( - section.subSections, - depth + 1, - prefixes + [section.name] - ) - else '' + std.objectFieldsAll(obj) + ), + + objects: + std.foldl( + function(acc, k) + acc + [ + root.obj( + root.util.realkey(k), + obj[k], + obj[root.util.realkey(k)], + path, + ), + ], + keys, + [] ) - for section in sections - ]), - - sections: { - base: { - subSections: [], - values: [], - }, - object(key, doc, obj, depth):: self.base { - name: std.strReplace(key, '#', ''), - - local processed = root.prepare(obj, depth=depth + 1), - - subSections: processed.sections, - - values: processed.values, - - type: { full: 'object', abbr: 'obj' }, - - abbr: self.type.abbr, - - doc: - if self.type.full in doc - then doc[self.type.full] - else { help: '' }, - - help: self.doc.help, - - linkName: self.name, - - content: - if self.help != '' - then self.help + '\n' - else '', - }, - - 'function'(key, doc):: self.base { - name: std.strReplace(key, '#', ''), + + std.foldl( + function(acc, k) + local o = root.obj( + k, + { object: { help: '' } }, + obj[k], + path, + ); + acc + + (if o.fields.hasFields() + then [o] + else []), + undocumentedKeys, + [] + ), + + hasFields(): std.length(self.objects) > 0, + + toIndex(): + if self.hasFields() + then + std.join('', [ + std.join( + '', + [' ' for d in std.range(0, (std.length(path) * 2) - 1)] + + ['* ', f.link] + + ['\n'] + + (if f.fields.hasFields() + then [f.fields.toIndex()] + else []) + ) + for f in self.objects + ]) + else '', - type: { full: 'function', abbr: 'fn' }, + toString(): + if self.hasFields() + then + std.join('', [ + o.toString() + for o in self.objects + ]) + else '', + }, - abbr: self.type.abbr, + obj(name, doc, obj, path): { + fields: root.fields(obj, path + [name]), + + path: std.join('.', path + [name]), + fragment: root.util.fragment(std.join('', path + [name])), + link: '[`obj %s`](#obj-%s)' % [name, self.fragment], + + toString(): + std.join( + '\n', + [root.util.title('obj ' + self.path, std.length(path) + 2)] + + (if std.get(doc.object, 'help', '') != '' + then [doc.object.help] + else []) + + [self.fields.toString()] + ), + }, - doc: doc[self.type.full], + findFunctions(obj, path=[]): { + local keys = + std.filter( + root.util.filter('function', obj), + std.objectFieldsAll(obj) + ), + + functions: + std.foldl( + function(acc, k) + acc + [ + root.func( + root.util.realkey(k), + obj[k], + path, + ), + ], + keys, + [] + ), + + hasFields(): std.length(self.functions) > 0, + + toIndex(): + if self.hasFields() + then + std.join('', [ + std.join( + '', + [' ' for d in std.range(0, (std.length(path) * 2) - 1)] + + ['* ', f.link] + + ['\n'] + ) + for f in self.functions + ]) + else '', - help: self.doc.help, + toString(): + if self.hasFields() + then + std.join('', [ + f.toString() + for f in self.functions + ]) + else '', + }, - args: std.join(', ', [ - if arg.default != null + func(name, doc, path): { + path: std.join('.', path + [name]), + fragment: root.util.fragment(std.join('', path + [name])), + link: '[`fn %s(%s)`](#fn-%s)' % [name, self.args, self.fragment], + + local getType(arg) = + local type = + if 'schema' in arg + then std.get(arg.schema, 'type', '') + else std.get(arg, 'type', ''); + if std.isArray(type) + then std.join(',', ['`%s`' % t for t in std.set(type)]) + else '`%s`' % type, + + // Use BelRune as default can be 'null' as a value. Only supported for arg.schema, arg.default didn't support this, not sure how to support without breaking asssumptions downstream. + local BelRune = std.char(7), + local getDefault(arg) = + if 'schema' in arg + then std.get(arg.schema, 'default', BelRune) + else + local d = std.get(arg, 'default', BelRune); + if d == null + then BelRune + else d, + + local getEnum(arg) = + if 'schema' in arg + then std.get(arg.schema, 'enum', []) + else + local d = std.get(arg, 'enums', []); + if d == null + then [] + else d, + + local manifest(value) = + std.manifestJsonEx(value, '', '', ': '), + + args: + std.join(', ', [ + local default = getDefault(arg); + if default != BelRune then std.join('=', [ arg.name, - std.manifestJsonEx(arg.default, '', ''), + manifest(default), ]) else arg.name - for arg in self.doc.args + for arg in doc['function'].args ]), - enums: std.join('', [ - if arg.enums != null - then '\n\nAccepted values for `%s` are ' % arg.name - + std.join(', ', [ - std.manifestJsonEx(item, '', '') - for item in arg.enums - ]) - else '' - for arg in self.doc.args - ]), - - linkName: '%(name)s(%(args)s)' % self, - - content: - (||| - ```ts - %(name)s(%(args)s) - ``` - - ||| % self) - + '%(help)s' % self - + '%(enums)s' % self, - // odd concatenation to prevent unintential newline changes - - }, - value(key, doc, obj):: self.base { - name: std.strReplace(key, '#', ''), - type: doc.value.type, - help: doc.value.help, - value: obj, - }, + args_list: + if std.length(doc['function'].args) > 0 + then + '\nPARAMETERS:\n\n' + + std.join('\n', [ + '* **%s** (%s)' % [arg.name, getType(arg)] + + ( + local default = getDefault(arg); + if default != BelRune + then '\n - default value: `%s`' % manifest(default) + else '' + ) + + ( + local enum = getEnum(arg); + if enum != [] + then + '\n - valid values: %s' % + std.join(', ', [ + '`%s`' % manifest(item) + for item in enum + ]) + else '' + ) + for arg in doc['function'].args + ]) + else '', - package(doc, root):: { - name: doc.name, - content: + toString(): + std.join('\n', [ + root.util.title('fn ' + self.path, std.length(path) + 2), ||| - %(help)s - ||| % doc - + (if 'installTemplate' in doc - then ||| - - ## Install - - ``` - %(install)s - ``` - ||| % doc.installTemplate % doc - else '') - + (if 'usageTemplate' in doc - then ||| - - ## Usage - - ```jsonnet - %(usage)s - ``` - ||| % doc.usageTemplate % doc - else ''), - }, + ```jsonnet + %s(%s) + ``` + %s + ||| % [self.path, self.args, self.args_list], + std.get(doc['function'], 'help', ''), + ]), }, - prepare(obj, depth=0):: - std.foldl( - function(acc, key) - acc + - // Package definition - if key == '#' - then root.sections.package( - obj[key], - (depth == 0) - ) - - - // Field definition - else if std.startsWith(key, '#') - then ( - local realKey = key[1:]; + findValues(obj, path=[]): { + local keys = + std.filter( + root.util.filter('value', obj), + std.objectFieldsAll(obj) + ), + + values: + std.foldl( + function(acc, k) + acc + [ + root.val( + root.util.realkey(k), + obj[k], + obj[root.util.realkey(k)], + path, + ), + ], + keys, + [] + ), + + hasFields(): std.length(self.values) > 0, + + toString(): + if self.hasFields() + then + std.join('\n', [ + '* ' + f.toString() + for f in self.values + ]) + '\n' + else '', + }, - if !std.isObject(obj[key]) - then - std.trace( - 'INFO: docstring "%s" cannot be parsed, ignored while rendering.' % key, - {} - ) + val(name, doc, obj, path): { + toString(): + std.join(' ', [ + '`%s`' % std.join('.', path + [name]), + '(`%s`):' % doc.value.type, + '`"%s"`' % obj, + '-', + std.get(doc.value, 'help', ''), + ]), + }, - else if 'value' in obj[key] - then { - values+: [root.sections.value( - key, - obj[key], - obj[realKey] - )], - } - else if 'function' in obj[key] - then { - functionSections+: [root.sections['function']( - key, - obj[key], - )], - } - else if 'object' in obj[key] - then { - objectSections+: [root.sections.object( - key, - obj[key], - obj[realKey], - depth - )], - } - else - std.trace( - 'INFO: docstring "%s" cannot be parsed, ignored while rendering.' % key, - {} - ) + util: { + realkey(key): + assert std.startsWith(key, '#') : 'Key %s not a docstring key' % key; + key[1:], + title(title, depth=0): + std.join( + '', + ['\n'] + + ['#' for i in std.range(0, depth)] + + [' ', title, '\n'] + ), + fragment(title): + std.asciiLower( + std.strReplace( + std.strReplace(title, '.', '') + , ' ', '-' ) + ), + filter(type, obj): + function(k) + std.all([ + std.startsWith(k, '#'), + std.isObject(obj[k]), + !std.objectHasAll(obj[k], 'ignore'), + type in obj[k], + root.util.realkey(k) in obj, + ]), + + getRelativePath(path, relativeTo): + local shortest = std.min(std.length(relativeTo), std.length(path)); + + local commonIndex = + std.foldl( + function(acc, i) ( + if acc.stop + then acc + else + acc + { + // stop count if path diverges + local stop = relativeTo[i] != path[i], + stop: stop, + count+: if stop then 0 else 1, + } + ), + std.range(0, shortest - 1), + { stop: false, count: 0 } + ).count; - // subPackage definition - else if std.isObject(obj[key]) && '#' in obj[key] - then { - subPackages+: [root.prepare(obj[key])], - } - - // undocumented object - else if std.isObject(obj[key]) && !('#' + key in obj) - then ( - local section = root.sections.object( - key, - {}, - obj[key], - depth - ); - // only add if has documented subSections or values - if std.length(section.subSections) > 0 - || std.length(section.values) > 0 - then { objectSections+: [section] } - else {} - ) + local _relativeTo = relativeTo[commonIndex:]; + local _path = path[commonIndex:]; - else {}, - std.objectFieldsAll(obj), - { - functionSections: [], - objectSections: [], - - sections: - self.functionSections - + self.objectSections, - subPackages: [], - values: [], - } - ), - - renderIndexPage(package, prefixes):: - root.templates.indexPage % { - name: package.name, - prefix: root.joinPrefixes(prefixes), - index: std.join('\n', [ - '* [%(name)s](%(name)s.md)' % sub - for sub in package.subPackages - ]), - }, - - renderFiles(package, prefixes=[]): - local path = root.joinPathPrefixes(prefixes); - ( - if std.length(prefixes) == 0 - then { - [path + 'README.md']: root.renderPackage(package, package.name + '/'), - } - else if std.length(package.subPackages) > 0 - then { - [path + package.name + '/index.md']: root.renderPackage(package), - } - else { - [path + package.name + '.md']: root.renderPackage(package, package.name + '/'), - } - ) - + std.foldl( - function(acc, sub) - acc + sub, - [ - root.renderFiles( - sub, - prefixes=prefixes + [package.name] - ) - for sub in package.subPackages - ], - {} - ), + // prefix for relative difference + local prefix = ['..' for i in std.range(0, std.length(_relativeTo) - 1)]; - render(obj): - self.renderFiles(self.prepare(obj)), + // return path with prefix + prefix + _path, + }, } diff --git a/vendor/github.com/jsonnet-libs/xtd/.github/workflows/tests.yml b/vendor/github.com/jsonnet-libs/xtd/.github/workflows/tests.yml new file mode 100644 index 0000000..bfe3f82 --- /dev/null +++ b/vendor/github.com/jsonnet-libs/xtd/.github/workflows/tests.yml @@ -0,0 +1,32 @@ +name: tests +on: + pull_request: {} + push: + branches: + - main + - master + +jobs: + test: + name: test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v4 + - name: make test + run: | + go install github.com/google/go-jsonnet/cmd/jsonnet@latest + go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest + make test + docs: + name: docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v4 + - name: make docs + run: | + go install github.com/jsonnet-libs/docsonnet@master + make docs + git diff --exit-code + \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet b/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet index 78d3c1c..d32ddb3 100644 --- a/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet @@ -1,4 +1,4 @@ -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { local this = self, diff --git a/vendor/github.com/jsonnet-libs/xtd/array.libsonnet b/vendor/github.com/jsonnet-libs/xtd/array.libsonnet index f000c87..b43c0f0 100644 --- a/vendor/github.com/jsonnet-libs/xtd/array.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/array.libsonnet @@ -1,4 +1,4 @@ -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { '#': d.pkg( @@ -34,4 +34,22 @@ local d = import 'doc-util/main.libsonnet'; else std.length(indexable), }; indexable[invar.index:invar.end:step], + + '#filterMapWithIndex':: d.fn( + ||| + `filterMapWithIndex` works the same as `std.filterMap` with the addition that the index is passed to the functions. + + `filter_func` and `map_func` function signature: `function(index, array_item)` + |||, + [ + d.arg('filter_func', d.T.func), + d.arg('map_func', d.T.func), + d.arg('arr', d.T.array), + ], + ), + filterMapWithIndex(filter_func, map_func, arr): [ + map_func(i, arr[i]) + for i in std.range(0, std.length(arr) - 1) + if filter_func(i, arr[i]) + ], } diff --git a/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet b/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet index 28571ac..f7962d0 100644 --- a/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet @@ -1,4 +1,4 @@ -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { '#': d.pkg( @@ -13,27 +13,23 @@ local d = import 'doc-util/main.libsonnet'; '`isLower` reports whether ASCII character `c` is a lower case letter', [d.arg('c', d.T.string)] ), - isLower(c): - if cp(c) >= 97 && cp(c) < 123 - then true - else false, + isLower(c): cp(c) >= 97 && cp(c) < 123, '#isUpper':: d.fn( '`isUpper` reports whether ASCII character `c` is a upper case letter', [d.arg('c', d.T.string)] ), - isUpper(c): - if cp(c) >= 65 && cp(c) < 91 - then true - else false, + isUpper(c): cp(c) >= 65 && cp(c) < 91, '#isNumber':: d.fn( '`isNumber` reports whether character `c` is a number.', [d.arg('c', d.T.string)] ), - isNumber(c): - if std.isNumber(c) || (cp(c) >= 48 && cp(c) < 58) - then true - else false, + isNumber(c): std.isNumber(c) || (cp(c) >= 48 && cp(c) < 58), + '#isStringNumeric':: d.fn( + '`isStringNumeric` reports whether string `s` consists only of numeric characters.', + [d.arg('str', d.T.string)] + ), + isStringNumeric(str): std.all(std.map(self.isNumber, std.stringChars(str))), } diff --git a/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet b/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet index 06b519b..ee42c66 100644 --- a/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet @@ -1,5 +1,5 @@ local xtd = import './main.libsonnet'; -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { '#': d.pkg( @@ -77,4 +77,24 @@ local d = import 'doc-util/main.libsonnet'; if r != '' ], + '#toCamelCase':: d.fn( + ||| + `toCamelCase` transforms a string to camelCase format, splitting words by the `-`, `_` or spaces. + For example: `hello_world` becomes `helloWorld`. + For more info please check: http://en.wikipedia.org/wiki/CamelCase + |||, + [d.arg('str', d.T.string)] + ), + toCamelCase(str):: + local separators = std.set(std.findSubstr('_', str) + std.findSubstr('-', str) + std.findSubstr(' ', str)); + local n = std.join('', [ + if std.setMember(i - 1, separators) + then std.asciiUpper(str[i]) + else str[i] + for i in std.range(0, std.length(str) - 1) + if !std.setMember(i, separators) + ]); + if std.length(n) == 0 + then n + else std.asciiLower(n[0]) + n[1:], } diff --git a/vendor/github.com/jsonnet-libs/xtd/date.libsonnet b/vendor/github.com/jsonnet-libs/xtd/date.libsonnet index e611ed4..a8243e7 100644 --- a/vendor/github.com/jsonnet-libs/xtd/date.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/date.libsonnet @@ -1,4 +1,4 @@ -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { '#': d.pkg( @@ -55,4 +55,131 @@ local d = import 'doc-util/main.libsonnet'; if month > 2 && self.isLeapYear(year) then 1 else 0, + + // yearSeconds returns the number of seconds in the given year. + local yearSeconds(year) = ( + if $.isLeapYear(year) + then 366 * 24 * 3600 + else 365 * 24 * 3600 + ), + + // monthSeconds returns the number of seconds in the given month of a given year. + local monthSeconds(year, month) = ( + commonYearMonthLength[month - 1] * 24 * 3600 + + if month == 2 && $.isLeapYear(year) then 86400 else 0 + ), + + // sumYearsSeconds returns the number of seconds in all years since 1970 up to year-1. + local sumYearsSeconds(year) = std.foldl( + function(acc, y) acc + yearSeconds(y), + std.range(1970, year - 1), + 0, + ), + + // sumMonthsSeconds returns the number of seconds in all months up to month-1 of the given year. + local sumMonthsSeconds(year, month) = std.foldl( + function(acc, m) acc + monthSeconds(year, m), + std.range(1, month - 1), + 0, + ), + + // sumDaysSeconds returns the number of seconds in all days up to day-1. + local sumDaysSeconds(day) = (day - 1) * 24 * 3600, + + '#toUnixTimestamp': d.fn( + ||| + `toUnixTimestamp` calculates the unix timestamp of a given date. + |||, + [ + d.arg('year', d.T.number), + d.arg('month', d.T.number), + d.arg('day', d.T.number), + d.arg('hour', d.T.number), + d.arg('minute', d.T.number), + d.arg('second', d.T.number), + ], + ), + toUnixTimestamp(year, month, day, hour, minute, second):: + sumYearsSeconds(year) + sumMonthsSeconds(year, month) + sumDaysSeconds(day) + hour * 3600 + minute * 60 + second, + + // isNumeric checks that the input is a non-empty string containing only digit characters. + local isNumeric(input) = + assert std.type(input) == 'string' : 'isNumeric() only operates on string inputs, got %s' % std.type(input); + std.foldl( + function(acc, char) acc && std.codepoint('0') <= std.codepoint(char) && std.codepoint(char) <= std.codepoint('9'), + std.stringChars(input), + std.length(input) > 0, + ), + + // parseSeparatedNumbers parses input which has part `names` separated by `sep`. + // Returns an object which has one field for each name in `names` with its integer value. + local parseSeparatedNumbers(input, sep, names) = ( + assert std.type(input) == 'string' : 'parseSeparatedNumbers() only operates on string inputs, got %s' % std.type(input); + assert std.type(sep) == 'string' : 'parseSeparatedNumbers() only operates on string separators, got %s' % std.type(sep); + assert std.type(names) == 'array' : 'parseSeparatedNumbers() only operates on arrays of names, got input %s' % std.type(names); + + local parts = std.split(input, sep); + assert std.length(parts) == std.length(names) : 'expected %(expected)d parts separated by %(sep)s in %(format)s formatted input "%(input)s", but got %(got)d' % { + expected: std.length(names), + sep: sep, + format: std.join(sep, names), + input: input, + got: std.length(parts), + }; + + { + [names[i]]: + // Fail with meaningful message if not numeric, otherwise it will be a hell to debug. + assert isNumeric(parts[i]) : '%(name)%s part "%(part)s" of %(format)s of input "%(input)s" is not numeric' % { + name: names[i], + part: parts[i], + format: std.join(sep, names), + input: input, + }; + std.parseInt(parts[i]) + for i in std.range(0, std.length(parts) - 1) + } + ), + + // stringContains is a helper function to check whether a string contains a given substring. + local stringContains(haystack, needle) = std.length(std.findSubstr(needle, haystack)) > 0, + + '#parseRFC3339': d.fn( + ||| + `parseRFC3339` parses an RFC3339-formatted date & time string (like `2020-01-02T03:04:05Z`) into an object containing the 'year', 'month', 'day', 'hour', 'minute' and 'second fields. + This is a limited implementation that does not support timezones (so it requires an UTC input ending in 'Z' or 'z') nor sub-second precision. + The returned object has a `toUnixTimestamp()` method that can be used to obtain the unix timestamp of the parsed date. + |||, + [ + d.arg('input', d.T.string), + ], + ), + parseRFC3339(input):: + // Basic input type check. + assert std.type(input) == 'string' : 'parseRFC3339() only operates on string inputs, got %s' % std.type(input); + + // Sub-second precision isn't implemented yet, warn the user about that instead of returning wrong results. + assert !stringContains(input, '.') : 'the provided RFC3339 input "%s" has a dot, most likely representing a sub-second precision, but this function does not support that' % input; + + // We don't support timezones, so string should end with 'Z' or 'z'. + assert std.endsWith(input, 'Z') || std.endsWith(input, 'z') : 'the provided RFC3339 "%s" should end with "Z" or "z". This implementation does not currently support timezones' % input; + + // RFC3339 can separate date and time using 'T', 't' or ' '. + // Find out which one it is and use it. + local sep = + if stringContains(input, 'T') then 'T' + else if stringContains(input, 't') then 't' + else if stringContains(input, ' ') then ' ' + else error 'the provided RFC3339 input "%s" should contain either a "T", or a "t" or space " " as a separator for date and time parts' % input; + + // Split date and time using the selected separator. + // Remove the last character as we know it's 'Z' or 'z' and it's not useful to us. + local datetime = std.split(std.substr(input, 0, std.length(input) - 1), sep); + assert std.length(datetime) == 2 : 'the provided RFC3339 timestamp "%(input)s" does not have date and time parts separated by the character "%(sep)s"' % { input: input, sep: sep }; + + local date = parseSeparatedNumbers(datetime[0], '-', ['year', 'month', 'day']); + local time = parseSeparatedNumbers(datetime[1], ':', ['hour', 'minute', 'second']); + date + time + { + toUnixTimestamp():: $.toUnixTimestamp(self.year, self.month, self.day, self.hour, self.minute, self.second), + }, } diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/README.md b/vendor/github.com/jsonnet-libs/xtd/docs/README.md index 0fbf376..61d9c39 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/README.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/README.md @@ -2,7 +2,7 @@ permalink: / --- -# package xtd +# xtd ```jsonnet local xtd = import "github.com/jsonnet-libs/xtd/main.libsonnet" @@ -14,8 +14,6 @@ This package serves as a test field for functions intended to be contributed to in the future, but also provides a place for less general, yet useful utilities. -## Subpackages - * [aggregate](aggregate.md) * [array](array.md) * [ascii](ascii.md) @@ -23,5 +21,6 @@ in the future, but also provides a place for less general, yet useful utilities. * [date](date.md) * [inspect](inspect.md) * [jsonpath](jsonpath.md) +* [number](number.md) * [string](string.md) * [url](url.md) \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md b/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md index aba530d..a877ddf 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md @@ -2,7 +2,7 @@ permalink: /aggregate/ --- -# package aggregate +# aggregate ```jsonnet local aggregate = import "github.com/jsonnet-libs/xtd/aggregate.libsonnet" diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/array.md b/vendor/github.com/jsonnet-libs/xtd/docs/array.md index 1d9e4a8..cc538d8 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/array.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/array.md @@ -2,7 +2,7 @@ permalink: /array/ --- -# package array +# array ```jsonnet local array = import "github.com/jsonnet-libs/xtd/array.libsonnet" @@ -12,10 +12,22 @@ local array = import "github.com/jsonnet-libs/xtd/array.libsonnet" ## Index +* [`fn filterMapWithIndex(filter_func, map_func, arr)`](#fn-filtermapwithindex) * [`fn slice(indexable, index, end='null', step=1)`](#fn-slice) ## Fields +### fn filterMapWithIndex + +```ts +filterMapWithIndex(filter_func, map_func, arr) +``` + +`filterMapWithIndex` works the same as `std.filterMap` with the addition that the index is passed to the functions. + +`filter_func` and `map_func` function signature: `function(index, array_item)` + + ### fn slice ```ts diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md b/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md index 37d7ed7..1ad7288 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md @@ -2,7 +2,7 @@ permalink: /ascii/ --- -# package ascii +# ascii ```jsonnet local ascii = import "github.com/jsonnet-libs/xtd/ascii.libsonnet" @@ -14,6 +14,7 @@ local ascii = import "github.com/jsonnet-libs/xtd/ascii.libsonnet" * [`fn isLower(c)`](#fn-islower) * [`fn isNumber(c)`](#fn-isnumber) +* [`fn isStringNumeric(str)`](#fn-isstringnumeric) * [`fn isUpper(c)`](#fn-isupper) ## Fields @@ -34,6 +35,14 @@ isNumber(c) `isNumber` reports whether character `c` is a number. +### fn isStringNumeric + +```ts +isStringNumeric(str) +``` + +`isStringNumeric` reports whether string `s` consists only of numeric characters. + ### fn isUpper ```ts diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md b/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md index 0634fa9..6c52147 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md @@ -2,7 +2,7 @@ permalink: /camelcase/ --- -# package camelcase +# camelcase ```jsonnet local camelcase = import "github.com/jsonnet-libs/xtd/camelcase.libsonnet" @@ -13,6 +13,7 @@ local camelcase = import "github.com/jsonnet-libs/xtd/camelcase.libsonnet" ## Index * [`fn split(src)`](#fn-split) +* [`fn toCamelCase(str)`](#fn-tocamelcase) ## Fields @@ -27,3 +28,14 @@ digits. Both lower camel case and upper camel case are supported. It only suppor ASCII characters. For more info please check: http://en.wikipedia.org/wiki/CamelCase Based on https://github.com/fatih/camelcase/ + + +### fn toCamelCase + +```ts +toCamelCase(str) +``` + +`toCamelCase` transforms a string to camelCase format, splitting words by the `-`, `_` or spaces. +For example: `hello_world` becomes `helloWorld`. +For more info please check: http://en.wikipedia.org/wiki/CamelCase diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/date.md b/vendor/github.com/jsonnet-libs/xtd/docs/date.md index e2c9295..1fcb9eb 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/date.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/date.md @@ -2,7 +2,7 @@ permalink: /date/ --- -# package date +# date ```jsonnet local date = import "github.com/jsonnet-libs/xtd/date.libsonnet" @@ -15,6 +15,8 @@ local date = import "github.com/jsonnet-libs/xtd/date.libsonnet" * [`fn dayOfWeek(year, month, day)`](#fn-dayofweek) * [`fn dayOfYear(year, month, day)`](#fn-dayofyear) * [`fn isLeapYear(year)`](#fn-isleapyear) +* [`fn parseRFC3339(input)`](#fn-parserfc3339) +* [`fn toUnixTimestamp(year, month, day, hour, minute, second)`](#fn-tounixtimestamp) ## Fields @@ -42,4 +44,23 @@ for common years, and 1-366 for leap years. isLeapYear(year) ``` -`isLeapYear` returns true if the given year is a leap year. \ No newline at end of file +`isLeapYear` returns true if the given year is a leap year. + +### fn parseRFC3339 + +```ts +parseRFC3339(input) +``` + +`parseRFC3339` parses an RFC3339-formatted date & time string (like `2020-01-02T03:04:05Z`) into an object containing the 'year', 'month', 'day', 'hour', 'minute' and 'second fields. +This is a limited implementation that does not support timezones (so it requires an UTC input ending in 'Z' or 'z') nor sub-second precision. +The returned object has a `toUnixTimestamp()` method that can be used to obtain the unix timestamp of the parsed date. + + +### fn toUnixTimestamp + +```ts +toUnixTimestamp(year, month, day, hour, minute, second) +``` + +`toUnixTimestamp` calculates the unix timestamp of a given date. diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md b/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md index 1ec3605..94575ca 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md @@ -2,7 +2,7 @@ permalink: /inspect/ --- -# package inspect +# inspect ```jsonnet local inspect = import "github.com/jsonnet-libs/xtd/inspect.libsonnet" @@ -13,6 +13,8 @@ local inspect = import "github.com/jsonnet-libs/xtd/inspect.libsonnet" ## Index * [`fn diff(input1, input2)`](#fn-diff) +* [`fn filterKubernetesObjects(object, kind='')`](#fn-filterkubernetesobjects) +* [`fn filterObjects(filter_func, x)`](#fn-filterobjects) * [`fn inspect(object, maxDepth)`](#fn-inspect) ## Fields @@ -54,6 +56,33 @@ Output: ``` +### fn filterKubernetesObjects + +```ts +filterKubernetesObjects(object, kind='') +``` + +`filterKubernetesObjects` implements `filterObjects` to return all Kubernetes objects in +an array, assuming that Kubernetes object are characterized by having an +`apiVersion` and `kind` field. + +The `object` argument can either be an object or an array, other types will be +ignored. The `kind` allows to filter out a specific kind, if unset all kinds will +be returned. + + +### fn filterObjects + +```ts +filterObjects(filter_func, x) +``` + +`filterObjects` walks a JSON tree returning all matching objects in an array. + +The `x` argument can either be an object or an array, other types will be +ignored. + + ### fn inspect ```ts diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md b/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md index f498803..94a4a4b 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md @@ -2,7 +2,7 @@ permalink: /jsonpath/ --- -# package jsonpath +# jsonpath ```jsonnet local jsonpath = import "github.com/jsonnet-libs/xtd/jsonpath.libsonnet" @@ -13,7 +13,7 @@ local jsonpath = import "github.com/jsonnet-libs/xtd/jsonpath.libsonnet" ## Index * [`fn convertBracketToDot(path)`](#fn-convertbrackettodot) -* [`fn getJSONPath(source, path)`](#fn-getjsonpath) +* [`fn getJSONPath(source, path, default='null')`](#fn-getjsonpath) * [`fn parseFilterExpr(path)`](#fn-parsefilterexpr) ## Fields @@ -32,7 +32,7 @@ This function does not support escaping brackets/quotes in path keys. ### fn getJSONPath ```ts -getJSONPath(source, path) +getJSONPath(source, path, default='null') ``` `getJSONPath` gets the value at `path` from `source` where path is a JSONPath. diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/number.md b/vendor/github.com/jsonnet-libs/xtd/docs/number.md new file mode 100644 index 0000000..aa30879 --- /dev/null +++ b/vendor/github.com/jsonnet-libs/xtd/docs/number.md @@ -0,0 +1,43 @@ +--- +permalink: /number/ +--- + +# number + +```jsonnet +local number = import "github.com/jsonnet-libs/xtd/number.libsonnet" +``` + +`number` implements helper functions for processing number. + +## Index + +* [`fn inRange(v, from, to)`](#fn-inrange) +* [`fn maxInArray(arr, default=0)`](#fn-maxinarray) +* [`fn minInArray(arr, default=0)`](#fn-mininarray) + +## Fields + +### fn inRange + +```ts +inRange(v, from, to) +``` + +`inRange` returns true if `v` is in the given from/to range.` + +### fn maxInArray + +```ts +maxInArray(arr, default=0) +``` + +`maxInArray` finds the biggest number in an array + +### fn minInArray + +```ts +minInArray(arr, default=0) +``` + +`minInArray` finds the smallest number in an array \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/string.md b/vendor/github.com/jsonnet-libs/xtd/docs/string.md index 17b75b5..62873e5 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/string.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/string.md @@ -2,7 +2,7 @@ permalink: /string/ --- -# package string +# string ```jsonnet local string = import "github.com/jsonnet-libs/xtd/string.libsonnet" diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/url.md b/vendor/github.com/jsonnet-libs/xtd/docs/url.md index 5529d5b..db898bc 100644 --- a/vendor/github.com/jsonnet-libs/xtd/docs/url.md +++ b/vendor/github.com/jsonnet-libs/xtd/docs/url.md @@ -2,18 +2,20 @@ permalink: /url/ --- -# package url +# url ```jsonnet local url = import "github.com/jsonnet-libs/xtd/url.libsonnet" ``` -`url` implements URL escaping and query building +`url` provides functions to deal with URLs ## Index * [`fn encodeQuery(params)`](#fn-encodequery) -* [`fn escapeString(str, excludedChars)`](#fn-escapestring) +* [`fn escapeString(str, excludedChars=[])`](#fn-escapestring) +* [`fn join(splitObj)`](#fn-join) +* [`fn parse(url)`](#fn-parse) ## Fields @@ -28,7 +30,27 @@ encodeQuery(params) ### fn escapeString ```ts -escapeString(str, excludedChars) +escapeString(str, excludedChars=[]) ``` -`escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences \ No newline at end of file +`escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences + +### fn join + +```ts +join(splitObj) +``` + +`join` joins URLs from the object generated from `parse` + +### fn parse + +```ts +parse(url) +``` + +`parse` parses absolute and relative URLs. + +:///;parameters?# + +Inspired by Python's urllib.urlparse, following several RFC specifications. diff --git a/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet b/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet index 051ed0d..495679d 100644 --- a/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet @@ -1,13 +1,14 @@ -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { + local this = self, + '#': d.pkg( name='inspect', url='github.com/jsonnet-libs/xtd/inspect.libsonnet', help='`inspect` implements helper functions for inspecting Jsonnet', ), - '#inspect':: d.fn( ||| `inspect` reports the structure of a Jsonnet object with a recursion depth of @@ -19,8 +20,6 @@ local d = import 'doc-util/main.libsonnet'; //d.arg('depth', d.T.number), // used for recursion, not exposing in docs ] ), - - local this = self, inspect(object, maxDepth=10, depth=0): std.foldl( function(acc, p) @@ -85,7 +84,6 @@ local d = import 'doc-util/main.libsonnet'; d.arg('input2', d.T.any), ] ), - diff(input1, input2):: if input1 == input2 then '' @@ -143,4 +141,69 @@ local d = import 'doc-util/main.libsonnet'; } else '~[ %s ]' % std.join(' , ', [std.toString(input1), std.toString(input2)]), + + '#filterObjects':: d.fn( + ||| + `filterObjects` walks a JSON tree returning all matching objects in an array. + + The `x` argument can either be an object or an array, other types will be + ignored. + |||, + args=[ + d.arg('filter_func', d.T.func), + d.arg('x', d.T.any), + ] + ), + filterObjects(filter_func, x): + if std.isObject(x) + then + if filter_func(x) + then [x] + else + std.foldl( + function(acc, o) + acc + self.filterObjects(filter_func, x[o]), + std.objectFields(x), + [] + ) + else if std.isArray(x) + then + std.flattenArrays( + std.map( + function(obj) + self.filterObjects(filter_func, obj), + x + ) + ) + else [], + + '#filterKubernetesObjects':: d.fn( + ||| + `filterKubernetesObjects` implements `filterObjects` to return all Kubernetes objects in + an array, assuming that Kubernetes object are characterized by having an + `apiVersion` and `kind` field. + + The `object` argument can either be an object or an array, other types will be + ignored. The `kind` allows to filter out a specific kind, if unset all kinds will + be returned. + |||, + args=[ + d.arg('object', d.T.any), + d.arg('kind', d.T.string, default=''), + ] + ), + filterKubernetesObjects(object, kind=''): + local objects = self.filterObjects( + function(object) + std.objectHas(object, 'apiVersion') + && std.objectHas(object, 'kind'), + object, + ); + if kind == '' + then objects + else + std.filter( + function(o) o.kind == kind, + objects + ), } diff --git a/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet b/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet index 7722d64..49f15bc 100644 --- a/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet @@ -1,5 +1,5 @@ local xtd = import './main.libsonnet'; -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { '#': d.pkg( diff --git a/vendor/github.com/jsonnet-libs/xtd/main.libsonnet b/vendor/github.com/jsonnet-libs/xtd/main.libsonnet index 59c4034..5bda297 100644 --- a/vendor/github.com/jsonnet-libs/xtd/main.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/main.libsonnet @@ -1,4 +1,4 @@ -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { '#': d.pkg( @@ -19,6 +19,7 @@ local d = import 'doc-util/main.libsonnet'; date: (import './date.libsonnet'), inspect: (import './inspect.libsonnet'), jsonpath: (import './jsonpath.libsonnet'), + number: (import './number.libsonnet'), string: (import './string.libsonnet'), url: (import './url.libsonnet'), } diff --git a/vendor/github.com/jsonnet-libs/xtd/number.libsonnet b/vendor/github.com/jsonnet-libs/xtd/number.libsonnet new file mode 100644 index 0000000..6ebdece --- /dev/null +++ b/vendor/github.com/jsonnet-libs/xtd/number.libsonnet @@ -0,0 +1,48 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='number', + url='github.com/jsonnet-libs/xtd/number.libsonnet', + help='`number` implements helper functions for processing number.', + ), + + '#inRange':: d.fn( + '`inRange` returns true if `v` is in the given from/to range.`', + [ + d.arg('v', d.T.number), + d.arg('from', d.T.number), + d.arg('to', d.T.number), + ] + ), + inRange(v, from, to): + v > from && v <= to, + + '#maxInArray':: d.fn( + '`maxInArray` finds the biggest number in an array', + [ + d.arg('arr', d.T.array), + d.arg('default', d.T.number, default=0), + ] + ), + maxInArray(arr, default=0): + std.foldl( + std.max, + std.set(arr), + default, + ), + + '#minInArray':: d.fn( + '`minInArray` finds the smallest number in an array', + [ + d.arg('arr', d.T.array), + d.arg('default', d.T.number, default=0), + ] + ), + minInArray(arr, default=0): + std.foldl( + std.min, + std.set(arr), + default, + ), +} diff --git a/vendor/github.com/jsonnet-libs/xtd/string.libsonnet b/vendor/github.com/jsonnet-libs/xtd/string.libsonnet index 5514cde..6655981 100644 --- a/vendor/github.com/jsonnet-libs/xtd/string.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/string.libsonnet @@ -1,4 +1,4 @@ -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { '#': d.pkg( diff --git a/vendor/github.com/jsonnet-libs/xtd/test/ascii_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/ascii_test.jsonnet new file mode 100644 index 0000000..077b350 --- /dev/null +++ b/vendor/github.com/jsonnet-libs/xtd/test/ascii_test.jsonnet @@ -0,0 +1,44 @@ +local ascii = import '../ascii.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) + ++ test.case.new( + name='all numeric', + test=test.expect.eq( + actual=ascii.isStringNumeric('123'), + expected=true, + ) +) + ++ test.case.new( + name='only beginning numeric', + test=test.expect.eq( + actual=ascii.isStringNumeric('123abc'), + expected=false, + ) +) + ++ test.case.new( + name='only end numeric', + test=test.expect.eq( + actual=ascii.isStringNumeric('abc123'), + expected=false, + ) +) + ++ test.case.new( + name='none numeric', + test=test.expect.eq( + actual=ascii.isStringNumeric('abc'), + expected=false, + ) +) + ++ test.case.new( + name='empty', + test=test.expect.eq( + actual=ascii.isStringNumeric(''), + expected=true, + ) +) diff --git a/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet index b171c64..2dcadc0 100644 --- a/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet @@ -4,117 +4,173 @@ local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; test.new(std.thisFile) + test.case.new( - name='nostring', + name='split: nostring', test=test.expect.eq( actual=xtd.camelcase.split(''), expected=[''], ) ) + test.case.new( - name='lowercase', + name='split: lowercase', test=test.expect.eq( actual=xtd.camelcase.split('lowercase'), expected=['lowercase'], ) ) + test.case.new( - name='Class', + name='split: Class', test=test.expect.eq( actual=xtd.camelcase.split('Class'), expected=['Class'], ) ) + test.case.new( - name='MyClass', + name='split: MyClass', test=test.expect.eq( actual=xtd.camelcase.split('MyClass'), expected=['My', 'Class'], ) ) + test.case.new( - name='MyC', + name='split: MyC', test=test.expect.eq( actual=xtd.camelcase.split('MyC'), expected=['My', 'C'], ) ) + test.case.new( - name='HTML', + name='split: HTML', test=test.expect.eq( actual=xtd.camelcase.split('HTML'), expected=['HTML'], ) ) + test.case.new( - name='PDFLoader', + name='split: PDFLoader', test=test.expect.eq( actual=xtd.camelcase.split('PDFLoader'), expected=['PDF', 'Loader'], ) ) + test.case.new( - name='AString', + name='split: AString', test=test.expect.eq( actual=xtd.camelcase.split('AString'), expected=['A', 'String'], ) ) + test.case.new( - name='SimpleXMLParser', + name='split: SimpleXMLParser', test=test.expect.eq( actual=xtd.camelcase.split('SimpleXMLParser'), expected=['Simple', 'XML', 'Parser'], ) ) + test.case.new( - name='vimRPCPlugin', + name='split: vimRPCPlugin', test=test.expect.eq( actual=xtd.camelcase.split('vimRPCPlugin'), expected=['vim', 'RPC', 'Plugin'], ) ) + test.case.new( - name='GL11Version', + name='split: GL11Version', test=test.expect.eq( actual=xtd.camelcase.split('GL11Version'), expected=['GL', '11', 'Version'], ) ) + test.case.new( - name='99Bottles', + name='split: 99Bottles', test=test.expect.eq( actual=xtd.camelcase.split('99Bottles'), expected=['99', 'Bottles'], ) ) + test.case.new( - name='May5', + name='split: May5', test=test.expect.eq( actual=xtd.camelcase.split('May5'), expected=['May', '5'], ) ) + test.case.new( - name='BFG9000', + name='split: BFG9000', test=test.expect.eq( actual=xtd.camelcase.split('BFG9000'), expected=['BFG', '9000'], ) ) + test.case.new( - name='Two spaces', + name='split: Two spaces', test=test.expect.eq( actual=xtd.camelcase.split('Two spaces'), expected=['Two', ' ', 'spaces'], ) ) + test.case.new( - name='Multiple Random spaces', + name='split: Multiple Random spaces', test=test.expect.eq( actual=xtd.camelcase.split('Multiple Random spaces'), expected=['Multiple', ' ', 'Random', ' ', 'spaces'], ) ) ++ test.case.new( + name='toCamelCase: empty string', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase(''), + expected='', + ) +) ++ test.case.new( + name='toCamelCase: lowercase', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lowercase'), + expected='lowercase', + ) +) ++ test.case.new( + name='toCamelCase: underscores', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower_case'), + expected='lowerCase', + ) +) ++ test.case.new( + name='toCamelCase: dashes', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower-case'), + expected='lowerCase', + ) +) ++ test.case.new( + name='toCamelCase: spaces', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower case'), + expected='lowerCase', + ) +) ++ test.case.new( + name='toCamelCase: mixed', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower_case-mixed'), + expected='lowerCaseMixed', + ) +) ++ test.case.new( + name='toCamelCase: multiple spaces', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower case'), + expected='lowerCase', + ) +) ++ test.case.new( + name='toCamelCase: PascalCase', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('PascalCase'), + expected='pascalCase', + ) +) // TODO: find or create is(Upper|Lower) for non-ascii characters // Something like this for Jsonnet: diff --git a/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet index c0ebe77..9746428 100644 --- a/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet @@ -129,3 +129,91 @@ test.new(std.thisFile) expected=166, ) ) + ++ test.case.new( + name='toUnixTimestamp of 1970-01-01 00:00:00 (zero)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1970, 1, 1, 0, 0, 0), + expected=0, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 1970-01-02 00:00:00 (one day)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1970, 1, 2, 0, 0, 0), + expected=86400, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 1971-01-01 00:00:00 (one year)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1971, 1, 1, 0, 0, 0), + expected=365 * 24 * 3600, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 1972-03-01 00:00:00 (month of leap year)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1972, 3, 1, 0, 0, 0), + expected=2 * 365 * 24 * 3600 + 31 * 24 * 3600 + 29 * 24 * 3600, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 1974-01-01 00:00:00 (incl leap year)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1974, 1, 1, 0, 0, 0), + expected=(4 * 365 + 1) * 24 * 3600, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 2020-01-02 03:04:05 (full date)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(2020, 1, 2, 3, 4, 5), + expected=1577934245, + ), +) + ++ test.case.new( + name='parseRFC3339 of 1970-01-01T00:00:00Z (standard unix zero)', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('1970-01-01T00:00:00Z'), + expected={ year: 1970, month: 1, day: 1, hour: 0, minute: 0, second: 0 }, + ), +) + ++ test.case.new( + name='parseRFC3339 of 2020-01-02T03:04:05Z (non-zero date)', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('2020-01-02T03:04:05Z'), + expected={ year: 2020, month: 1, day: 2, hour: 3, minute: 4, second: 5 }, + ), +) + ++ test.case.new( + name='parseRFC3339 of 2020-01-02 03:04:05Z (space separator)', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('2020-01-02 03:04:05Z'), + expected={ year: 2020, month: 1, day: 2, hour: 3, minute: 4, second: 5 }, + ), +) + ++ test.case.new( + name='parseRFC3339 of 2020-01-02t03:04:05Z (lowercase t separator and lowercase z)', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('2020-01-02t03:04:05z'), + expected={ year: 2020, month: 1, day: 2, hour: 3, minute: 4, second: 5 }, + ), +) + ++ test.case.new( + name='parseRFC3339(..).toUnixTimestamp()', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('2020-01-02T03:04:05Z').toUnixTimestamp(), + expected=1577934245, + ), +) diff --git a/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet index f837966..b2393a2 100644 --- a/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet @@ -73,3 +73,137 @@ test.new(std.thisFile) expected='oe=utf8&q=puppies', ) ) + +// url.parse ++ test.case.new( + name='Full absolute URL', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location;type=person?name=john#address'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + params: 'type=person', + query: 'name=john', + fragment: 'address', + }, + ) +) + ++ test.case.new( + name='URL with fragment before params and query', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location#address;type=person?name=john'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + fragment: 'address;type=person?name=john', + }, + ) +) + ++ test.case.new( + name='URL without query', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location;type=person#address'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + params: 'type=person', + fragment: 'address', + }, + ) +) + ++ test.case.new( + name='URL without params', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location?name=john#address'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + query: 'name=john', + fragment: 'address', + }, + ) +) + ++ test.case.new( + name='URL with empty fragment', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location#'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + fragment: '', + }, + ) +) + ++ test.case.new( + name='host with port', + test=test.expect.eqJson( + actual=xtd.url.parse('//example.com:80'), + expected={ + netloc: 'example.com:80', + hostname: 'example.com', + port: '80', + }, + ) +) + ++ test.case.new( + name='mailto', + test=test.expect.eqJson( + actual=xtd.url.parse('mailto:john@example.com'), + expected={ + scheme: 'mailto', + path: 'john@example.com', + }, + ) +) + ++ test.case.new( + name='UserInfo', + test=test.expect.eqJson( + actual=xtd.url.parse('ftp://admin:password@example.com'), + + expected={ + hostname: 'example.com', + netloc: 'admin:password@example.com', + scheme: 'ftp', + username: 'admin', + password: 'password', + } + , + ) +) + ++ test.case.new( + name='Relative URL only', + test=test.expect.eqJson( + actual=xtd.url.parse('/path/to/location'), + expected={ + path: '/path/to/location', + }, + ) +) + ++ test.case.new( + name='URL fragment only', + test=test.expect.eqJson( + actual=xtd.url.parse('#fragment_only'), + expected={ + fragment: 'fragment_only', + }, + ) +) diff --git a/vendor/github.com/jsonnet-libs/xtd/url.libsonnet b/vendor/github.com/jsonnet-libs/xtd/url.libsonnet index 80f367d..1509c0f 100644 --- a/vendor/github.com/jsonnet-libs/xtd/url.libsonnet +++ b/vendor/github.com/jsonnet-libs/xtd/url.libsonnet @@ -1,21 +1,111 @@ -local d = import 'doc-util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; { '#': d.pkg( name='url', url='github.com/jsonnet-libs/xtd/url.libsonnet', - help='`url` implements URL escaping and query building', + help='`url` provides functions to deal with URLs', ), - '#escapeString': d.fn('`escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences', [d.arg('str', d.T.string), d.arg('excludedChars', d.T.array)]), + '#escapeString': d.fn( + '`escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences', + args=[ + d.arg('str', d.T.string), + d.arg('excludedChars', d.T.array, default=[]), + ], + ), escapeString(str, excludedChars=[]):: local allowedChars = '0123456789abcdefghijklmnopqrstuvwqxyzABCDEFGHIJKLMNOPQRSTUVWQXYZ'; local utf8(char) = std.foldl(function(a, b) a + '%%%02X' % b, std.encodeUTF8(char), ''); local escapeChar(char) = if std.member(excludedChars, char) || std.member(allowedChars, char) then char else utf8(char); std.join('', std.map(escapeChar, std.stringChars(str))), - '#encodeQuery': d.fn('`encodeQuery` takes an object of query parameters and returns them as an escaped `key=value` string', [d.arg('params', d.T.object)]), + '#encodeQuery': d.fn( + '`encodeQuery` takes an object of query parameters and returns them as an escaped `key=value` string', + args=[d.arg('params', d.T.object)], + ), encodeQuery(params):: local fmtParam(p) = '%s=%s' % [self.escapeString(p), self.escapeString(params[p])]; std.join('&', std.map(fmtParam, std.objectFields(params))), + + '#parse': d.fn( + ||| + `parse` parses absolute and relative URLs. + + :///;parameters?# + + Inspired by Python's urllib.urlparse, following several RFC specifications. + |||, + args=[d.arg('url', d.T.string)], + ), + parse(url): + local hasFragment = std.member(url, '#'); + local fragmentSplit = std.splitLimit(url, '#', 1); + local fragment = fragmentSplit[1]; + + local hasQuery = std.member(fragmentSplit[0], '?'); + local querySplit = std.splitLimit(fragmentSplit[0], '?', 1); + local query = querySplit[1]; + + local hasParams = std.member(querySplit[0], ';'); + local paramsSplit = std.splitLimit(querySplit[0], ';', 1); + local params = paramsSplit[1]; + + local hasNetLoc = std.member(paramsSplit[0], '//'); + local netLocSplit = std.splitLimit(paramsSplit[0], '//', 1); + local netLoc = std.splitLimit(netLocSplit[1], '/', 1)[0]; + + local hasScheme = std.member(netLocSplit[0], ':'); + local schemeSplit = std.splitLimit(netLocSplit[0], ':', 1); + local scheme = schemeSplit[0]; + + local path = + if hasNetLoc && std.member(netLocSplit[1], '/') + then '/' + std.splitLimit(netLocSplit[1], '/', 1)[1] + else if hasScheme + then schemeSplit[1] + else netLocSplit[0]; + local hasPath = (path != ''); + + local hasUserInfo = hasNetLoc && std.member(netLoc, '@'); + local userInfoSplit = std.reverse(std.splitLimitR(netLoc, '@', 1)); + local userInfo = userInfoSplit[1]; + + local hasPassword = hasUserInfo && std.member(userInfo, ':'); + local passwordSplit = std.splitLimitR(userInfo, ':', 1); + local username = passwordSplit[0]; + local password = passwordSplit[1]; + + local hasPort = hasNetLoc && std.length(std.findSubstr(':', userInfoSplit[0])) > 0; + local portSplit = std.splitLimitR(userInfoSplit[0], ':', 1); + local host = portSplit[0]; + local port = portSplit[1]; + + { + [if hasScheme then 'scheme']: scheme, + [if hasNetLoc then 'netloc']: netLoc, + [if hasPath then 'path']: path, + [if hasParams then 'params']: params, + [if hasQuery then 'query']: query, + [if hasFragment then 'fragment']: fragment, + + [if hasUserInfo then 'username']: username, + [if hasPassword then 'password']: password, + [if hasNetLoc then 'hostname']: host, + [if hasPort then 'port']: port, + }, + + '#join': d.fn( + '`join` joins URLs from the object generated from `parse`', + args=[d.arg('splitObj', d.T.object)], + ), + join(splitObj): + std.join('', [ + if 'scheme' in splitObj then splitObj.scheme + ':' else '', + if 'netloc' in splitObj then '//' + splitObj.netloc else '', + if 'path' in splitObj then splitObj.path else '', + if 'params' in splitObj then ';' + splitObj.params else '', + if 'query' in splitObj then '?' + splitObj.query else '', + if 'fragment' in splitObj then '#' + splitObj.fragment else '', + ]), } diff --git a/vendor/grafonnet-base b/vendor/grafonnet-base deleted file mode 120000 index fc4a3fe..0000000 --- a/vendor/grafonnet-base +++ /dev/null @@ -1 +0,0 @@ -github.com/grafana/grafonnet/grafonnet-base \ No newline at end of file diff --git a/vendor/grafonnet-v10.0.0 b/vendor/grafonnet-v10.0.0 deleted file mode 120000 index 3749c7b..0000000 --- a/vendor/grafonnet-v10.0.0 +++ /dev/null @@ -1 +0,0 @@ -github.com/grafana/grafonnet/gen/grafonnet-v10.0.0 \ No newline at end of file diff --git a/vendor/grafonnet-v10.2.0 b/vendor/grafonnet-v10.2.0 new file mode 120000 index 0000000..7f0730b --- /dev/null +++ b/vendor/grafonnet-v10.2.0 @@ -0,0 +1 @@ +github.com/grafana/grafonnet/gen/grafonnet-v10.2.0 \ No newline at end of file diff --git a/vendor/grizzly b/vendor/grizzly new file mode 120000 index 0000000..c8729a6 --- /dev/null +++ b/vendor/grizzly @@ -0,0 +1 @@ +github.com/grafana/jsonnet-libs/grizzly \ No newline at end of file diff --git a/vendor/v10.0.0 b/vendor/v10.0.0 deleted file mode 120000 index 5ee7dc4..0000000 --- a/vendor/v10.0.0 +++ /dev/null @@ -1 +0,0 @@ -github.com/grafana/grok/jsonnet/v10.0.0 \ No newline at end of file diff --git a/vendor/validate-libsonnet b/vendor/validate-libsonnet deleted file mode 120000 index d16d8d7..0000000 --- a/vendor/validate-libsonnet +++ /dev/null @@ -1 +0,0 @@ -github.com/crdsonnet/validate-libsonnet \ No newline at end of file