Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Deubler <tim.deubler@here.com>
  • Loading branch information
TerminalTim committed Sep 5, 2024
1 parent 5eb99bc commit c7ac6a4
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions packages/core/src/styles/BoxStyle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -235,14 +235,14 @@ export interface BoxStyle {
light?: string;

/**
* Sets the emissive color of the extruded polygon, giving it a glow effect.
* Sets the emissive color of the `"Box"`, giving it a glow effect.
*
* @see {@link Color} for a detailed list of possible supported formats.
*/
emissive?: Color | StyleValueFunction<Color> | StyleZoomRange<Color> | StyleExpression<Color>;

/**
* Sets the specular color of the extruded polygon, affecting how it reflects light.
* Sets the specular color of the `"Box"`, affecting how it reflects light.
*
* ### Relationship with Shininess
* - **Effect:** The `specular` property determines the color of the light reflection, while the {@link shininess} value controls the intensity and size of the reflection.
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/styles/GenericStyle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -638,18 +638,18 @@ export interface Style {
light?: string;

/**
* Sets the emissive color of the extruded polygon, giving it a glow effect.
* Sets the emissive color of the feature, giving it a glow effect.
*
* This property is only applicable for Styles of type `"Polygon"`, `"Box"` or `"Sphere"`;
* This property is only applicable for Styles of type `"Polygon"`, `"Box"`, `"Sphere"` or `"Model"`;
*
* @see {@link Color} for a detailed list of possible supported formats.
*/
emissive?: Color | StyleValueFunction<Color> | StyleZoomRange<Color> | StyleExpression<Color>;

/**
* Sets the specular color of the extruded polygon, affecting how it reflects light.
* Sets the specular color of the feature, affecting how it reflects light.
*
* This property is only applicable for Styles of type `"Polygon"`, `"Box"` or `"Sphere"`;
* This property is only applicable for Styles of type `"Polygon"`, `"Box"`, `"Sphere"` or `"Model"`;
*
* ### Relationship with Shininess
* - **Effect:** The `specular` property determines the color of the light reflection, while the {@link shininess} value controls the intensity and size of the reflection.
Expand All @@ -660,10 +660,10 @@ export interface Style {
specular?: Color | StyleValueFunction<Color> | StyleZoomRange<Color> | StyleExpression<Color>;

/**
* Sets the shininess of the extruded polygon, determining how glossy its surface appears.
* Sets the shininess of the feature, determining how glossy its surface appears.
* A higher value makes the polygon surface more reflective.
*
* This property is only applicable for Styles of type `"Polygon"`, `"Box"` or `"Sphere"`;
* This property is only applicable for Styles of type `"Polygon"`, `"Box"`, `"Sphere"` or `"Model"`;
*
* ### Relationship with Specular
* - **Effect:** The `shininess` value controls the size and intensity of the specular highlight, which is colored by the {@link specular} property.
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/styles/SphereStyle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,14 +166,14 @@ export interface SphereStyle {
light?: string;

/**
* Sets the emissive color of the extruded polygon, giving it a glow effect.
* Sets the emissive color of the `"Sphere"`, giving it a glow effect.
*
* @see {@link Color} for a detailed list of possible supported formats.
*/
emissive?: Color | StyleValueFunction<Color> | StyleZoomRange<Color> | StyleExpression<Color>;

/**
* Sets the specular color of the extruded polygon, affecting how it reflects light.
* Sets the specular color of the `"Sphere"`, affecting how it reflects light.
*
* ### Relationship with Shininess
* - **Effect:** The `specular` property determines the color of the light reflection, while the {@link shininess} value controls the intensity and size of the reflection.
Expand Down

0 comments on commit c7ac6a4

Please sign in to comment.