Charting Settings

Charting Settings

@toothfairyai/sdk@latest…

Charting Settings Management Module Handles charting settings retrieval and updates.

Accessed via client.chartingSettings.

Methods

Method	HTTP	Endpoint
get	GET	GET /charting_settings/get
update	POST	POST /charting_settings/update

get

Get charting settings for the workspace

async get()

Endpoint: GET /charting_settings/get

Field-level schema not available in the API spec for this endpoint.

Example

const result = await client.chartingSettings.get();

update

Update charting settings

async update(
    options: {
    primaryColor?: string;
    secondaryColor?: string;
    lineColor?: string;
    backgroundColor?: string;
    textColor?: string;
  } = {}
)

Endpoint: POST /charting_settings/update · API service

Request fields

Field	Type	Required	Description
workspaceid	string	no	Unique workspace identifier (UUID v4)
primaryColor	string	no	Primary Color
secondaryColor	string	no	Secondary Color
tertiaryColor	string	no	Tertiary Color
primaryTextColor	string	no	Primary text color
primaryBorderColor	string	no	Primary border color
lineColor	string	no	Line Color
plotPrimaryColor	string	no	Plot Primary Color
plotSecondaryColor	string	no	Plot Secondary Color
plotTertiaryColor	string	no	Plot Tertiary Color
xyBackgroundColor	string	no	XY Background Color

Response fields

Field	Type	Description
workspaceid	string	Unique workspace identifier (UUID v4)
primaryColor	string	Primary Color
secondaryColor	string	Secondary Color
tertiaryColor	string	Tertiary Color
primaryTextColor	string	Primary text color
primaryBorderColor	string	Primary border color
lineColor	string	Line Color
plotPrimaryColor	string	Plot Primary Color
plotSecondaryColor	string	Plot Secondary Color
plotTertiaryColor	string	Plot Tertiary Color
xyBackgroundColor	string	XY Background Color

Example

const result = await client.chartingSettings.update();