GoodData JS SDK GoodDataJS
gooddata-js v13.5.0

project Class

Defined in: src/project.ts:66
Module: project

Functions for working with projects

Show:

createProject

(
  • title
  • authorizationToken
  • options
)
Object

Defined in src/project.ts:245

Create project Note: returns a promise which is resolved when the project creation is finished

Parameters

  • title String
  • authorizationToken String
  • options Object

    for project creation (summary, projectTemplate, ...)

Returns

Object:

created project object

deleteAllObjects

(
  • projectId
  • dashboardUri
)

Provided by the metadata module.

Defined in src/metadataExt.ts:167

Deletes dashboard and its objects (only the author of the dashboard can delete the dashboard and its objects)

Parameters

  • projectId String

    Project identifier

  • dashboardUri String

    Uri of a dashboard to be deleted

deleteProject

(
  • projectId
)

Defined in src/project.ts:297

Delete project

Parameters

  • projectId String

getColorPalette

(
  • projectId
)
Array

Defined in src/project.ts:132

Fetches a chart color palette for a project represented by the given projectId parameter.

Parameters

  • projectId String
    • A project identifier

Returns

Array:

An array of objects with r, g, b fields representing a project's color palette

getColorPaletteWithGuids

(
  • projectId
)
Array

Defined in src/project.ts:165

Fetches a chart color palette for a project represented by the given projectId parameter.

Parameters

  • projectId String
    • A project identifier

Returns

Array:

An array of objects representing a project's color palette with color guid or undefined

getCurrentProjectId

() String

Defined in src/project.ts:75

Get current project id

Returns

String:

current project identifier

getCurrentProjectIdInBootstrap

(
  • bootstrapData
)

Defined in src/project.ts:88

Return current project id in bootstrap

Parameters

  • bootstrapData Object
    • data was got from bootstrap resource

getDatasets

(
  • projectId
)
Array

Defined in src/project.ts:118

Fetches all datasets for the given project

Parameters

  • projectId String
    • GD project identifier

Returns

Array:

An array of objects containing datasets metadata

getFeatureFlags

(
  • projectId
)
IFeatureFlags

Defined in src/project.ts:307

Gets aggregated feature flags for given project and current user

Parameters

  • projectId String
    • A project identifier

Returns

IFeatureFlags:

Hash table of feature flags and theirs values where feature flag is as key

getProjects

(
  • profileId
)
Array

Defined in src/project.ts:103

Fetches projects available for the user represented by the given profileId

Parameters

  • profileId String
    • User profile identifier

Returns

Array:

An Array of projects

getTimezone

(
  • projectId
)

Defined in src/project.ts:209

Gets current timezone and its offset. Example output:

{
                                                id: 'Europe/Prague',
                                                displayName: 'Central European Time',
                                                currentOffsetMs: 3600000
                                            }

Parameters

  • projectId String
    • GD project identifier

setColorPalette

(
  • projectId
  • colors
)

Defined in src/project.ts:189

Sets given colors as a color palette for a given project.

Parameters

  • projectId String
    • GD project identifier
  • colors Array
    • An array of colors that we want to use within the project. Each color should be an object with r, g, b fields. // TODO really object?

© GoodData 2019