6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
22 KiB
22 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "@grafana/data" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
@grafana/data package
A library containing most of the core functionality and data types used in Grafana.
Classes
| Class | Description |
|---|---|
| AppendedVectors | This may be more trouble than it is worth. This trades some computation time for RAM -- rather than allocate a new array the size of all previous arrays, this just points the correct index to their original array values |
| AppPlugin | |
| ArrayVector | |
| CircularDataFrame | This dataframe can have values constantly added, and will never exceed the given capacity |
| CircularVector | Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add.This supports addting to the 'head' or 'tail' and will grow the buffer to match a configured capacity. |
| ConstantVector | |
| CSVReader | |
| DataFrameView | (BETA) This abstraction will present the contents of a DataFrame as if it were a well typed javascript object Vector. |
| DataSourceApi | The main data source abstraction interface, represents an instance of a data sourceAlthough this is a class, datasource implementations do not *yet* need to extend it. As such, we can not yet add functions with default implementations. |
| DataSourcePlugin | |
| FieldCache | |
| GrafanaPlugin | |
| LanguageProvider | |
| MutableDataFrame | |
| PanelPlugin | |
| Registry | |
| ScaledVector | |
| SortedVector | Values are returned in the order defined by the input parameter |
Enumerations
| Enumeration | Description |
|---|---|
| ColorScheme | |
| CoreApp | |
| CSVHeaderStyle | |
| DataSourceStatus | |
| DataTransformerID | |
| ExploreMode | |
| FieldColorMode | |
| FieldMatcherID | |
| FieldType | |
| FrameMatcherID | Field name matchers |
| GrafanaThemeType | |
| LoadingState | |
| LogLevel | Mapping of log level abbreviation to canonical log level. Supported levels are reduce to limit color variation. |
| LogsDedupDescription | |
| LogsDedupStrategy | |
| LogsMetaKind | |
| MappingType | |
| MatcherID | |
| NullValueMode | |
| OrgRole | |
| PluginIncludeType | |
| PluginState | |
| PluginType | |
| ReducerID | |
| ThresholdsMode | |
| VariableOrigin | |
| VariableSuggestionsScope | |
| VizOrientation |
Functions
Interfaces
Namespaces
| Namespace | Description |
|---|---|
| AppEvents | |
| dateMath | |
| PanelEvents | |
| rangeUtil |
Variables
Type Aliases
| Type Alias | Description |
|---|---|
| Color | |
| ColorDefinition | |
| DataQueryResponseData | |
| DataSourceOptionsType | |
| DataSourceQueryType | |
| DataTransformer | Immutable data transformation |
| DateTimeInput | |
| DecimalCount | |
| Dimensions | |
| DisplayProcessor | |
| DurationInput | |
| DurationUnit | |
| FieldConfigEditorRegistry | |
| FieldMatcher | |
| FormatInput | |
| FrameMatcher | |
| GraphSeriesValue | |
| InterpolateFunction | |
| KeyValue | |
| LegacyResponseData | Starting in v6.2 DataFrame can represent both TimeSeries and TableData |
| LinkTarget | |
| MutableField | |
| NavIndex | |
| Omit | |
| PanelMigrationHandler | Called when a panel is first loaded with current panel model |
| PanelTypeChangedHandler | Called before a panel is initialized |
| ScaleCalculator | |
| Subtract | |
| TimeFragment | |
| TimeSeriesPoints | |
| TimeSeriesValue | |
| TimeZone | |
| TimeZoneBrowser | |
| TimeZoneUtc | |
| ValueFormatter | |
| ValueMapping |