Interface ApiOptions

interface ApiOptions {
    appendixDocument?: JsonApiDocument;
    appname?: string;
    appurlname?: string;
    datasetState?: DatasetState[];
    draft?: boolean;
    endpoint?: string;
    env?: string;
    excludedDatasets?: string[];
    id?: string;
    locale?: LocaleType;
    onlyQueryable?: boolean;
    onlyRenderable?: boolean;
    orgname?: string;
    store?: JsonApiStore;
    testdata?: TestdataOptions;
}

Properties

appendixDocument? appname? appurlname? datasetState? draft? endpoint? env? excludedDatasets? id? locale? onlyQueryable? onlyRenderable? orgname? store? testdata?

Properties

OptionalappendixDocument

appendixDocument?: JsonApiDocument

JSON-API document to append to fetched payloads

Optionalappname

appname?: string

Optionalappurlname

appurlname?: string

OptionaldatasetState

datasetState?: DatasetState[]

Initial datasets

Optionaldraft

draft?: boolean

Optionalendpoint

endpoint?: string

Endpoint for the catalog NOTE: Default is https://datakatalog.miljoeportal.dk/api

Optionalenv

env?: string

OptionalexcludedDatasets

excludedDatasets?: string[]

Excluded dataset ids

Optionalid

id?: string

Optional ID for this instance. The datasetState is stored in localStorage. The ID can be used to control if two instances of the API schould share the stored datasetState

Optionallocale

locale?: LocaleType

The locale used

OptionalonlyQueryable

onlyQueryable?: boolean

Only use datasets that are queryable

OptionalonlyRenderable

onlyRenderable?: boolean

Only use datasets that are renderable

Optionalorgname

orgname?: string

Logging context params

Optionalstore

store?: JsonApiStore

Optionaltestdata

testdata?: TestdataOptions

Settings

Member Visibility

On This Page

Properties