import Mapcreator from '@mapcreator/api/src/Mapcreator.js'

public class | source

Mapcreator

Extends:

* → Mapcreator

Base API class

Constructor Summary

Public Constructor
public	constructor(auth: OAuth \| string, host: string)

Member Summary

Public Members
public get	auth: OAuth: * Get authentication provider instance
public set	auth(value: OAuth) Set authentication provider instance
public get	authenticated: boolean: * Test if the client is authenticated with the api and has a valid token
public get	choropleths: GeoResourceProxy<Choropleth>: * Choropleth accessor
public get	colors: ResourceProxy<Color>: * Color accessor
public get	contracts: ResourceProxy<Contract>: * Contract accessor
public get	dimensionSets: ResourceProxy<DimensionSet>: * Dimension set accessor
public get	dimensions: ResourceProxy<Dimension>: * Dimension accessor
public get	faqs: ResourceProxy<Faq>: * Faq accessor
public get	featuredMaps: SimpleResourceProxy<Job>: * Featured jobs accessor
public get	features: ResourceProxy<Feature>: * Feature accessor
public get	fontFamilies: ResourceProxy<FontFamily>: * FontFamily accessor
public get	fonts: ResourceProxy<Font>: * Font accessor
public get	highlights: GeoResourceProxy<Highlight>: * Highlight accessor
public get	host: string: * The current host
public set	host(value: string) The remote host
public get	insetMaps: GeoResourceProxy<InsetMap>: * InsetMap accessor
public get	jobShares: ResourceProxy<JobShare>: * JobShare accessor
public get	jobTypes: ResourceProxy<JobType>: * JobType accessor
public get	jobs: ResourceProxy<Job>: * Job accessor
public get	ky: function: * Mapcreator ky instance This ky instance takes care of the API communication.
public get	languages: ResourceProxy<Language>: * Language accessor
public get	layerFaqs: ResourceProxy<LayerFaq>: * LayerFaq accessor
public get	layerGroups: ResourceProxy<LayerGroup>: * Layer group accessor
public get	layers: ResourceProxy<Layer>: * Layer accessor
public get	logger: Logger: * Get logger instance
public get	mapstyleSets: ResourceProxy<MapstyleSet>: * MapstyleSet accessor
public get	mapstyles: ResourceProxy<Mapstyle>: * Mapstyle accessor
public get	messages: ResourceProxy<Message>: * Message accessor
public get	notifications: ResourceProxy<Notification>: * Notification accessor
public get	organisations: ResourceProxy<Organisation>: * Organisation accessor
public get	permissions: ResourceProxy<Permission>: * Permission accessor
public get	productTourSteps: ResourceProxy<ProductTourStep>: * Product tour step accessor
public get	productTours: ResourceProxy<ProductTour>: * Product tour accessor
public get	roles: ResourceProxy<Role>: * Role accessor
public get	svgSets: ResourceProxy<SvgSet>: * SvgSet accessor
public get	svgs: ResourceProxy<Svg>: * Svg accessor
public get	tagTypes: ResourceProxy<TagType>: * Tag accessor
public get	tags: ResourceProxy<Tag>: * Tag accessor
public get	url: string
public get	users: ResourceProxy<User>: * User accessor
public get	vectorChoropleths: GeoResourceProxy<VectorChoropleth>: * VectorChoropleth accessor
public get	vectorHighlights: GeoResourceProxy<VectorHighlight>: * VectorHighlight accessor
public get	version: string: string Get api version

Method Summary

Public Methods
public	async authenticate(): Promise<Mapcreator> Authenticate with the api using the authentication method provided.
public	getFontStyles(): CancelablePromise<Enum> Get font styles
public	getSvgSetTypes(): CancelablePromise<Enum> Get SVG set types
public	logout(): CancelablePromise Forget the current session This will clean up any stored OAuth states stored using StateContainer and any OAuth tokens stored
public	saveToken(name: string) Saves the session token so that it can be recovered at a later time.
public	static(Target: string \| Class, Constructor: Class?): ResourceProxy Static proxy generation
public	wrapKy(wrapper: , args: ...)

Public Constructors

public constructor(auth: OAuth | string, host: string) source

Params:

Name	Type	Attribute	Description
auth	OAuth \| string		Authentication flow
host	string		Remote API host

Public Members

public get auth: OAuth: * source

Get authentication provider instance

Return:

OAuth

OAuth instance

public set auth(value: OAuth) source

Set authentication provider instance

public get authenticated: boolean: * source

Test if the client is authenticated with the api and has a valid token

Return:

boolean

If the client is authenticated with the api

public get choropleths: GeoResourceProxy<Choropleth>: * source

Choropleth accessor

Return:

GeoResourceProxy<Choropleth>

A proxy for accessing the resource

See:

Choropleth

public get colors: ResourceProxy<Color>: * source

Color accessor

Return:

ResourceProxy<Color>

A proxy for accessing the resource

See:

Color

public get contracts: ResourceProxy<Contract>: * source

Contract accessor

Return:

ResourceProxy<Contract>

A proxy for accessing the resource

See:

Contract

public get dimensionSets: ResourceProxy<DimensionSet>: * source

Dimension set accessor

Return:

ResourceProxy<DimensionSet>

A proxy for accessing the resource

See:

DimensionSet

public get dimensions: ResourceProxy<Dimension>: * source

Dimension accessor

Return:

ResourceProxy<Dimension>

A proxy for accessing the resource

See:

Dimension

public get faqs: ResourceProxy<Faq>: * source

Faq accessor

Return:

ResourceProxy<Faq>

A proxy for accessing the resource

See:

public get featuredMaps: SimpleResourceProxy<Job>: * source

Featured jobs accessor

Return:

SimpleResourceProxy<Job>

A proxy for accessing the resource

See:

public get features: ResourceProxy<Feature>: * source

Feature accessor

Return:

ResourceProxy<Feature>

A proxy for accessing the resource

See:

Feature

public get fontFamilies: ResourceProxy<FontFamily>: * source

FontFamily accessor

Return:

ResourceProxy<FontFamily>

A proxy for accessing the resource

See:

FontFamily

public get fonts: ResourceProxy<Font>: * source

Font accessor

Return:

ResourceProxy<Font>

A proxy for accessing the resource

See:

Font

public get highlights: GeoResourceProxy<Highlight>: * source

Highlight accessor

Return:

GeoResourceProxy<Highlight>

A proxy for accessing the resource

See:

Highlight

public get host: string: * source

The current host

Return:

string

The current host

public set host(value: string) source

The remote host

public get insetMaps: GeoResourceProxy<InsetMap>: * source

InsetMap accessor

Return:

GeoResourceProxy<InsetMap>

A proxy for accessing the resource

See:

InsetMap

public get jobShares: ResourceProxy<JobShare>: * source

JobShare accessor

Return:

ResourceProxy<JobShare>

A proxy for accessing the resource

See:

JobShare

public get jobTypes: ResourceProxy<JobType>: * source

JobType accessor

Return:

ResourceProxy<JobType>

A proxy for accessing the resource

See:

JobType

public get jobs: ResourceProxy<Job>: * source

Job accessor

Return:

ResourceProxy<Job>

A proxy for accessing the resource

See:

public get ky: function: * source

Mapcreator ky instance This ky instance takes care of the API communication. It has the following responsibilities:

Send authenticated requests to the API
Transform errors returned from the API into ApiError and ValidationError if possible
Wait when the rate limiter responds with a 429 and retry later
Prefix urls with the api domain if needed

Return:

function

See:

https://github.com/sindresorhus/ky

public get languages: ResourceProxy<Language>: * source

Language accessor

Return:

ResourceProxy<Language>

A proxy for accessing the resource

See:

Language

public get layerFaqs: ResourceProxy<LayerFaq>: * source

LayerFaq accessor

Return:

ResourceProxy<LayerFaq>

A proxy for accessing the resource

See:

LayerFaq

public get layerGroups: ResourceProxy<LayerGroup>: * source

Layer group accessor

Return:

ResourceProxy<LayerGroup>

A proxy for accessing the resource

See:

LayerGroup

public get layers: ResourceProxy<Layer>: * source

Layer accessor

Return:

ResourceProxy<Layer>

A proxy for accessing the resource

See:

Layer

public get logger: Logger: * source

Get logger instance

Return:

Logger

Logger instance

public get mapstyleSets: ResourceProxy<MapstyleSet>: * source

MapstyleSet accessor

Return:

ResourceProxy<MapstyleSet>

A proxy for accessing the resource

See:

MapstyleSet

public get mapstyles: ResourceProxy<Mapstyle>: * source

Mapstyle accessor

Return:

ResourceProxy<Mapstyle>

A proxy for accessing the resource

See:

Mapstyle

public get messages: ResourceProxy<Message>: * source

Message accessor

Return:

ResourceProxy<Message>

A proxy for accessing the resource

See:

Message

public get notifications: ResourceProxy<Notification>: * source

Notification accessor

Return:

ResourceProxy<Notification>

A proxy for accessing the resource

See:

Notification

public get organisations: ResourceProxy<Organisation>: * source

Organisation accessor

Return:

ResourceProxy<Organisation>

A proxy for accessing the resource

See:

Organisation

public get permissions: ResourceProxy<Permission>: * source

Permission accessor

Return:

ResourceProxy<Permission>

A proxy for accessing the resource

See:

Permission

public get productTourSteps: ResourceProxy<ProductTourStep>: * source

Product tour step accessor

Return:

ResourceProxy<ProductTourStep>

A proxy for accessing the resource

See:

ProductTourStep

public get productTours: ResourceProxy<ProductTour>: * source

Product tour accessor

Return:

ResourceProxy<ProductTour>

A proxy for accessing the resource

See:

ProductTour

public get roles: ResourceProxy<Role>: * source

Role accessor

Return:

ResourceProxy<Role>

A proxy for accessing the resource

See:

Role

public get svgSets: ResourceProxy<SvgSet>: * source

SvgSet accessor

Return:

ResourceProxy<SvgSet>

A proxy for accessing the resource

See:

SvgSet

public get svgs: ResourceProxy<Svg>: * source

Svg accessor

Return:

ResourceProxy<Svg>

A proxy for accessing the resource

See:

public get tagTypes: ResourceProxy<TagType>: * source

Tag accessor

Return:

ResourceProxy<TagType>

A proxy for accessing the resource

See:

TagType

public get tags: ResourceProxy<Tag>: * source

Tag accessor

Return:

ResourceProxy<Tag>

A proxy for accessing the resource

See:

public get url: string source

public get users: ResourceProxy<User>: * source

User accessor

Return:

ResourceProxy<User>

A proxy for accessing the resource

See:

User

public get vectorChoropleths: GeoResourceProxy<VectorChoropleth>: * source

VectorChoropleth accessor

Return:

GeoResourceProxy<VectorChoropleth>

A proxy for accessing the resource

See:

VectorChoropleth

public get vectorHighlights: GeoResourceProxy<VectorHighlight>: * source

VectorHighlight accessor

Return:

GeoResourceProxy<VectorHighlight>

A proxy for accessing the resource

See:

VectorHighlight

public get version: string: string source

Get api version

Return:

string

Api version

Public Methods

public async authenticate(): Promise<Mapcreator> source

Authenticate with the api using the authentication method provided.

Return:

Promise<Mapcreator>

Current instance

Throw:

OAuthError
ApiError	If the api returns errors

public getFontStyles(): CancelablePromise<Enum> source

Get font styles

Return:

CancelablePromise<Enum>

Contains all the possible font styles

Throw:

ApiError

If the api returns errors

See:

Font

public getSvgSetTypes(): CancelablePromise<Enum> source

Get SVG set types

Return:

CancelablePromise<Enum>

Contains all the possible SVG set types

Throw:

ApiError

If the api returns errors

See:

SvgSet

public logout(): CancelablePromise source

Forget the current session This will clean up any stored OAuth states stored using StateContainer and any OAuth tokens stored

Return:

CancelablePromise

Throw:

ApiError

If the api returns errors

public saveToken(name: string) source

Saves the session token so that it can be recovered at a later time. The wrapper can find the token most of the time if the name parameter is left blank.

Params:

Name	Type	Attribute	Description
name	string		name of the token

public static(Target: string | Class, Constructor: Class?): ResourceProxy source

Static proxy generation

Params:

Name	Type	Attribute	Description
Target	string \| Class		Constructor or url
Constructor	Class?		Constructor for a resource that the results should be cast to

Return:

ResourceProxy

A proxy for accessing the resource

Example:

api.static('/custom/resource/path/{id}/').get(123);

class FooBar extends ResourceBase {
   static get resourceName() {
     return 'custom';
   }
}

api.static(FooBar)
  .get(1)
  .then(console.log);

api.static('/foo-bar-custom', FooBar).lister();

public wrapKy(wrapper: , args: ...) source

Params:

Name	Type	Attribute	Description
wrapper	*
args	...*