Class default

connector

emitter

isLoaded

options

createGroup

• createGroup(
      nameOrOptions: string | ResourceCreateOptions,
      opt?: ResourceCreateOptions,
  ): Promise<CreatedResource>

  Parameters

  • nameOrOptions: string | ResourceCreateOptions
  • opt: ResourceCreateOptions = {}

  Returns Promise<CreatedResource>

createRaster

• createRaster(options: CreateRasterOptions): Promise<CreatedResource>

  Parameters

  • options: CreateRasterOptions

  Returns Promise<CreatedResource>

createResource

• createResource(
      meta: FileMeta,
      name: string,
      options: RasterUploadOptions,
  ): Promise<CreatedResource> | undefined

  Parameters

  • meta: FileMeta
  • name: string
  • options: RasterUploadOptions

  Returns Promise<CreatedResource> | undefined

  Deprecated

  • use createRaster instead

createStyle

• createStyle(
      opt: CreateStyleOptions,
      name?: string | number,
  ): Promise<CreatedResource>

  Parameters

  • opt: CreateStyleOptions
  • Optionalname: string | number

  Returns Promise<CreatedResource>

createVector

• createVector(options: CreateRasterOptions): Promise<CreatedResource>

  Parameters

  • options: CreateRasterOptions

  Returns Promise<CreatedResource>

createWms

• createWms(
      opt: CreateWmsOptions,
      name?: string,
  ): Promise<CreatedResource> | undefined

  Parameters

  • opt: CreateWmsOptions
  • Optionalname: string

  Returns Promise<CreatedResource> | undefined

createWmsConnectedLayer

• createWmsConnectedLayer(
      opt: CreateWmsConnectedLayerOptions,
      name?: string,
  ): Promise<CreatedResource> | undefined

  Parameters

  • opt: CreateWmsConnectedLayerOptions
  • Optionalname: string

  Returns Promise<CreatedResource> | undefined

createWmsConnection

• createWmsConnection(
      opt: CreateWmsConnectionOptions,
      name?: string,
  ): Promise<CreatedResource> | undefined

  Parameters

  • opt: CreateWmsConnectionOptions
  • Optionalname: string

  Returns Promise<CreatedResource> | undefined

fileUpload

• fileUpload(file: FileType, options?: FileUploadOptions): Promise<FileMeta>

  Parameters

  • file: FileType
  • options: FileUploadOptions = {}

  Returns Promise<FileMeta>

getResource

• getResource(
      id: number,
      requestOptions?: GetRequestOptions<any, "json", false>,
  ): Promise<CompositeRead | undefined> | undefined

  Parameters

  • id: number
  • OptionalrequestOptions: GetRequestOptions<any, "json", false>

  Returns Promise<CompositeRead | undefined> | undefined

uploadRaster

• uploadRaster<F extends FileType = FileType>(
      file: F,
      options: RasterUploadOptions,
  ): Promise<CreatedResource>

  Type Parameters

  • F extends FileType = FileType

  Parameters

  • file: F
  • options: RasterUploadOptions

  Returns Promise<CreatedResource>

uploadVector

• uploadVector<F extends FileType = FileType>(
      file: F,
      options: VectorUploadOptions,
  ): Promise<CreatedResource>

  Type Parameters

  • F extends FileType = FileType

  Parameters

  • file: F
  • options: VectorUploadOptions

  Returns Promise<CreatedResource>