Class ColorStyleController

The ColorStyleController is responsible for all communication regarding color styles. Methods inside this controller can be called by window.SDK.colorStyle.{method-name}

Index

Methods

create duplicate getAll getById move remove rename update

Methods

create

create(): Promise<EditorResponse<string>>
This method creates a new color

Returns Promise<EditorResponse<string>>
the new created color id
- Defined in src/controllers/ColorStyleController.ts:45

duplicate

duplicate(id: string): Promise<EditorResponse<string>>
This method duplicates a color by the id
Parameters
- id: string
  the id of a specific color
Returns Promise<EditorResponse<string>>
id of the duplicated color
- Defined in src/controllers/ColorStyleController.ts:55

getAll

getAll(): Promise<EditorResponse<DocumentColor[]>>
This method returns the list of colors

Returns Promise<EditorResponse<DocumentColor[]>>
list of all colors
- Defined in src/controllers/ColorStyleController.ts:26

getById

getById(id: string): Promise<EditorResponse<DocumentColor>>
This method returns a color by id
Parameters
- id: string
  the id of a specific color
Returns Promise<EditorResponse<DocumentColor>>
color properties for given id
- Defined in src/controllers/ColorStyleController.ts:36

move

move(order: number, ids: string[]): Promise<EditorResponse<null>>
This method changes positions of colors
Parameters
- order: number
  the position of the colors
- ids: string[]
  the list of color IDs
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/ColorStyleController.ts:66

remove

remove(id: string): Promise<EditorResponse<null>>
This method removes a color
Parameters
- id: string
  the id of a specific color
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/ColorStyleController.ts:102

rename

rename(id: string, newColorName: string): Promise<EditorResponse<null>>
This method renames a color
Parameters
- id: string
  the id of a specific color
- newColorName: string
  the new name of the color
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/ColorStyleController.ts:77

update

update(id: string, newColorProperties: Color): Promise<EditorResponse<null>>
This method updates a color
Parameters
- id: string
  the id of a specific color
- newColorProperties: Color
  the new color properties
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/ColorStyleController.ts:88