Skip to main content

Class: ProjectUtils

Defined in: utils/ProjectUtils.ts:11

Utility methods for projects

Constructors​

Constructor​

new ProjectUtils(): ProjectUtils

Returns​

ProjectUtils

Methods​

getColorConfigs()​

static getColorConfigs(project): ColorConfig[]

Defined in: utils/ProjectUtils.ts:64

Returns the color configurations of a project's labels, points and shapes

Parameters​

project​

Pick<Project, "labels" | "points" | "shapes">

The project, or only its labels, points and shapes

Returns​

ColorConfig[]

The color configurations, including the fill and stroke colors of shapes

getMarkerConfigs()​

static getMarkerConfigs(project): MarkerConfig[]

Defined in: utils/ProjectUtils.ts:39

Returns the marker configurations of a project's points

Parameters​

project​

Pick<Project, "labels" | "points" | "shapes">

The project, or only its labels, points and shapes

Returns​

MarkerConfig[]

The marker configurations

getOpacityConfigs()​

static getOpacityConfigs(project): OpacityConfig[]

Defined in: utils/ProjectUtils.ts:106

Returns the opacity configurations of a project's labels, points and shapes

Parameters​

project​

Pick<Project, "labels" | "points" | "shapes">

The project, or only its labels, points and shapes

Returns​

OpacityConfig[]

The opacity configurations, including the shape, fill and stroke opacities of shapes

getSizeConfigs()​

static getSizeConfigs(project): SizeConfig[]

Defined in: utils/ProjectUtils.ts:51

Returns the size configurations of a project's points

Parameters​

project​

Pick<Project, "labels" | "points" | "shapes">

The project, or only its labels, points and shapes

Returns​

SizeConfig[]

The size configurations

getVisibilityConfigs()​

static getVisibilityConfigs(project): VisibilityConfig[]

Defined in: utils/ProjectUtils.ts:85

Returns the visibility configurations of a project's labels, points and shapes

Parameters​

project​

Pick<Project, "labels" | "points" | "shapes">

The project, or only its labels, points and shapes

Returns​

VisibilityConfig[]

The visibility configurations, including the shape, fill and stroke visibilities of shapes

hasData()​

static hasData(project): boolean

Defined in: utils/ProjectUtils.ts:18

Returns whether a project has any data objects

Parameters​

project​

Pick<Project, "images" | "labels" | "points" | "shapes" | "tables">

The project, or only its data objects

Returns​

boolean

true if the project has images, labels, points, shapes or tables