A color presentation object describes how a {@linkcode Color } should be represented as text and what edits are required to refer to it from source code.
For some languages one color can have multiple presentations, e.g. css can represent the color red with
the constant Red
, the hex-value #ff0000
, or in rgba and hsla forms. In csharp other representations
apply, e.g. System.Drawing.Color.Red
.
A color presentation object describes how a {@linkcode Color } should be represented as text and what edits are required to refer to it from source code. For some languages one color can have multiple presentations, e.g. css can represent the color red with the constant `Red`, the hex-value `#ff0000`, or in rgba and hsla forms. In csharp other representations apply, e.g. `System.Drawing.Color.Red`.
(additional-text-edits color-presentation)
An optional array of additional {@link TextEdit text edits} that are applied when selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
Returns: TextEdit[] | undefined
An optional array of additional {@link TextEdit text edits} that are applied when selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves. **Returns:** `TextEdit[] | undefined`
(label color-presentation)
The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.
Returns: string
The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation. **Returns:** `string`
(set-additional-text-edits! color-presentation value)
An optional array of additional {@link TextEdit text edits} that are applied when selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
An optional array of additional {@link TextEdit text edits} that are applied when selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
(set-label! color-presentation value)
The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.
The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.
(set-text-edit! color-presentation value)
An {@link TextEdit edit} which is applied to a document when selecting
this presentation for the color. When falsy
the {@link ColorPresentation.label label}
is used.
An {@link TextEdit edit} which is applied to a document when selecting this presentation for the color. When `falsy` the {@link ColorPresentation.label label} is used.
(text-edit color-presentation)
An {@link TextEdit edit} which is applied to a document when selecting
this presentation for the color. When falsy
the {@link ColorPresentation.label label}
is used.
Returns: TextEdit | undefined
An {@link TextEdit edit} which is applied to a document when selecting this presentation for the color. When `falsy` the {@link ColorPresentation.label label} is used. **Returns:** `TextEdit | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close