Skip to content

Commit

Permalink
Merge pull request #279 from tanghuang-liu/dev
Browse files Browse the repository at this point in the history 
docs - 完善文档
  • Loading branch information
@zouyaoji
zouyaoji authored Sep 21, 2022
2 parents 4f43708 + aa8dbd5 commit 60e47d3
Show file tree
Hide file tree
Showing 106 changed files with 561 additions and 519 deletions.
2 changes: 1 addition & 1 deletion website/docs/en-US/datasources/vc-datasource-geojson.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Basic usage of VcDatasourceGeojson component.
<!-- prettier-ignore -->
| Name | Type | Default | Description |
| ------------- | --------------------- | ------- | --------------------------------------------------------------------------------- |
| data | string\|Object | | `required` A url, GeoJSON object, or TopoJSON object to be loaded. |
| data | Cesium.Resource \| string \| AnyObject | | `required` A url, GeoJSON object, or TopoJSON object to be loaded. |
| show | boolean | `true` | `optional` Overrides the url to use for resolving relative links. |
| entities | Array\<[VcEntityProps](https://zouyaoji.top/vue-cesium/#/en-US/component/vc-entity)\> | `[]` | `optional` Specify the collection of entities to be added to the datasource. |
| sourceUri | string | | `optional` lOverrides the url to use for resolving relative links.|
Expand Down
6 changes: 3 additions & 3 deletions website/docs/en-US/geometries/vc-geometry-box.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ Basic usage of VcGeometryBox component.

| Name | Type | Default | Description |
| ------------ | ------ | ------- | ----------------------------------------------------------------------------------------------------------- |
| dimensions | Object | | `required` The width, depth, and height of the box stored in the x, y, and z coordinates of the Cartesian3. |
| vertexFormat | Object | | `optional` The vertex attributes to be computed. |
| dimensions | VcPosition | | `required` The width, depth, and height of the box stored in the x, y, and z coordinates of the Cartesian3. |
| vertexFormat | Cesium.VertexFormat | | `optional` The vertex attributes to be computed. |

### Events

Expand All @@ -140,7 +140,7 @@ Loading a box geometry outline. It is equivalent to initializing a `Cesium.BoxOu

| Name | Type | Default | Description |
| ---------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------- |
| dimensions | Object | | `required` The width, depth, and height of the box stored in the x, y, and z coordinates of the Cartesian3. |
| dimensions | VcPosition | | `required` The width, depth, and height of the box stored in the x, y, and z coordinates of the Cartesian3. |

### VcGeometryBoxOutline Events

Expand Down
10 changes: 5 additions & 5 deletions website/docs/en-US/geometries/vc-geometry-circle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,12 @@ Basic usage of VcGeometryCircle component.

| Name | Type | Default | Description |
| -------------- | ------ | ------- | --------------------------------------------------------------------------------------------------------- |
| center | Object | | `required` The circle's center point in the fixed frame. |
| center | VcPosition | | `required` The circle's center point in the fixed frame. |
| radius | number | | `required` The radius in meters. |
| ellipsoid | Object | | `optional` The ellipsoid the circle will be on. |
| ellipsoid | Cesium.Ellipsoid | | `optional` The ellipsoid the circle will be on. |
| height | number | `0.0` | `optional` The distance in meters between the circle and the ellipsoid surface. |
| granularity | number | `0.02` | `optional` The angular distance between points on the circle in radians. |
| vertexFormat | Object | | `optional` The vertex attributes to be computed. |
| vertexFormat | Cesium.VertexFormat | | `optional` The vertex attributes to be computed. |
| extrudedHeight | number | `0.0` | `optional` The distance in meters between the circle's extruded face and the ellipsoid surface. |
| stRotation | number | `0.0` | `optional` The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. |

Expand All @@ -142,9 +142,9 @@ Loading the circle geometry outline. It is equivalent to initializing a `Cesium.

| Name | Type | Default | Description |
| --------------------- | ------ | ------- | ----------------------------------------------------------------------------------------------- |
| center | Object | | `required` The circle's center point in the fixed frame. |
| center | VcPosition | | `required` The circle's center point in the fixed frame. |
| radius | number | | `required` The radius in meters. |
| ellipsoid | Object | | `optional` The ellipsoid the circle will be on. |
| ellipsoid | Cesium.Ellipsoid | | `optional` The ellipsoid the circle will be on. |
| height | number | `0.0` | `optional` The distance in meters between the circle and the ellipsoid surface. |
| granularity | number | `0.02` | `optional` The angular distance between points on the circle in radians. |
| extrudedHeight | number | `0.0` | `optional` The distance in meters between the circle's extruded face and the ellipsoid surface. |
Expand Down
6 changes: 3 additions & 3 deletions website/docs/en-US/geometries/vc-geometry-corridor.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,11 @@ Basic usage of VcGeometryCorridor component.
| ---- | ---- | ------- | ----------- | --------------- |
| positions | Array | | `required` An array of positions that define the center of the corridor. |
| width | number | | `required` The distance between the edges of the corridor in meters. |
| ellipsoid | Object | | `optional` The ellipsoid to be used as a reference. |
| ellipsoid | Cesium.Ellipsoid | | `optional` The ellipsoid to be used as a reference. |
| granularity | number | | `optional` The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. |
| height | number | `0` | `optional` The distance in meters between the ellipsoid surface and the positions. |
| extrudedHeight | number | | `optional` The distance in meters between the ellipsoid surface and the extruded face. |
| vertexFormat | Object | | `optional` The vertex attributes to be computed.|
| vertexFormat | Cesium.VertexFormat | | `optional` The vertex attributes to be computed.|
| cornerType | number | `0` | `optional` Determines the style of the corners. **ROUNDED: 0, MITERED: 1, BEVELED: 2** |0/1/2|

### Events
Expand All @@ -150,7 +150,7 @@ Loading a corridor geometry outline. It is equivalent to initializing a `Cesium.
| ---- | ---- | ------- | ----------- | --------------- |
| positions | Array | | `required` An array of positions that define the center of the corridor outline. |
| width | number | | `required` The distance between the edges of the corridor outline. |
| ellipsoid | Object | | `optional` The ellipsoid to be used as a reference. |
| ellipsoid | Cesium.Ellipsoid | | `optional` The ellipsoid to be used as a reference. |
| granularity | number | | `optional` The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. |
| height | number | `0` | `optional` The distance in meters between the ellipsoid surface and the positions. |
| extrudedHeight | number | | `optional` The distance in meters between the ellipsoid surface and the extruded face. |
Expand Down
2 changes: 1 addition & 1 deletion website/docs/en-US/geometries/vc-geometry-cylinder.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Basic usage of VcGeometryCylinder component.
| topRadius | number | | `required` A numeric Property specifying the radius of the top of the cylinder. |
| bottomRadius | number | | `required` A numeric Property specifying the radius of the bottom of the cylinder. |
| slices | number | `128` | `optional` The number of edges around the perimeter of the cylinder. |
| vertexFormat | Object | | `optional` The vertex attributes to be computed. |
| vertexFormat | Cesium.VertexFormat | | `optional` The vertex attributes to be computed. |

### Events

Expand Down
14 changes: 7 additions & 7 deletions website/docs/en-US/geometries/vc-geometry-ellipse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,16 +125,16 @@ Basic usage of VcGeometryEllipse component.

| Name | Type | Default | Description |
| -------------- | -------------- | ------- | ------------------------------------------------------------------------------------------------ |
| center | Object\|Array | | `required` The ellipse's center point in the fixed frame. |
| center | VcPosition\|Array | | `required` The ellipse's center point in the fixed frame. |
| semiMajorAxis | number | | `required` The length of the ellipse's semi-major axis in meters. |
| semiMinorAxis | number | | `required` The length of the ellipse's semi-minor axis in meters. |
| ellipsoid | Object | | `optional` The ellipsoid the ellipse will be on. |
| ellipsoid | Cesium.Ellipsoid | | `optional` The ellipsoid the ellipse will be on. |
| height | number | `0` | `optional` The distance in meters between the ellipse and the ellipsoid surface. |
| extrudedHeight | number | | `optional` The distance in meters between the ellipse's extruded face and the ellipsoid surface. |
| rotation | number | `0.0` | `optional` The angle of rotation counter-clockwise from north. |
| stRotation | number\|Object | `0.0` | `optional` The rotation of the texture coordinates counter-clockwise from north. |
| stRotation | number | `0.0` | `optional` The rotation of the texture coordinates counter-clockwise from north. |
| granularity | number | | `optional` The angular distance between points on the ellipse in radians. |
| vertexFormat | Object | | `optional` The vertex attributes to be computed. |
| vertexFormat | Cesium.VertexFormat | | `optional` The vertex attributes to be computed. |

### Events

Expand All @@ -154,14 +154,14 @@ Loading an ellipse geometry outline. It is equivalent to initializing a `Cesium.

| Name | Type | Default | Description |
| --------------------- | -------------- | ------- | ------------------------------------------------------------------------------------------------ |
| center | Object | | `required` The ellipse's center point in the fixed frame. |
| center | VcPosition | | `required` The ellipse's center point in the fixed frame. |
| semiMajorAxis | number | | `required` The length of the ellipse's semi-major axis in meters. |
| semiMinorAxis | number | | `required` The length of the ellipse's semi-minor axis in meters. |
| ellipsoid | Object | | `optional` The ellipsoid the ellipse will be on. |
| ellipsoid | Cesium.Ellipsoid | | `optional` The ellipsoid the ellipse will be on. |
| height | number | `0` | `optional` The distance in meters between the ellipse and the ellipsoid surface. |
| extrudedHeight | number | | `optional` The distance in meters between the ellipse's extruded face and the ellipsoid surface. |
| rotation | number | `0.0` | `optional` The angle of rotation counter-clockwise from north. |
| stRotation | number\|Object | `0.0` | `optional` The rotation of the texture coordinates counter-clockwise from north. |
| stRotation | number | `0.0` | `optional` The rotation of the texture coordinates counter-clockwise from north. |
| granularity | number | | `optional` The angular distance between points on the ellipse in radians. |
| numberOfVerticalLines | number | `16` | `optional` Number of lines to draw between the top and bottom surface of an extruded ellipse. |

Expand Down
6 changes: 3 additions & 3 deletions website/docs/en-US/geometries/vc-geometry-ellipsoid.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,15 @@ The basic usage of VcGeometryEllipsoid component.
<!-- prettier-ignore -->
| Name | Type | Default | Description |
| --------------- | ------------- | ------ | ----------------------------------------------------------- |
| radii | Object\|Array | | `optional` The radii of the ellipsoid in the x, y, and z directions. |
| radii | VcPosition\|Array | | `optional` The radii of the ellipsoid in the x, y, and z directions. |
| innerRadii | number | | `optional` The inner radii of the ellipsoid in the x, y, and z directions.|
| minimumClock | number | `0.0` | `optional` The minimum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. |
| maximumClock | number | `2*PI` | `optional` The maximum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. |
| minimumCone | number | `0.0` | `optional` The minimum angle measured from the positive z-axis and toward the negative z-axis. |
| maximumCone | number | `PI` | `optional` The maximum angle measured from the positive z-axis and toward the negative z-axis. |
| stackPartitions | number | `10` | `optional` The number of times to partition the ellipsoid into stacks. |
| slicePartitions | number | `8` | `optional` The number of times to partition the ellipsoid into radial slices.|
| vertexFormat | Object | | `optional` The vertex attributes to be computed. |
| vertexFormat | Cesium.VertexFormat | | `optional` The vertex attributes to be computed. |

### Events

Expand All @@ -160,7 +160,7 @@ Loading a ellipsoid geometry outline. It is equivalent to initializing a `Cesium
<!-- prettier-ignore -->
| Name | Type | Default | Description |
| --------------- | ------------- | ------- | ----------------------------------------------------------- |
| radii | Object\|Array | | `optional` The radii of the ellipsoid in the x, y, and z directions. |
| radii | VcPosition\|Array | | `optional` The radii of the ellipsoid in the x, y, and z directions. |
| innerRadii | number | | `optional` The inner radii of the ellipsoid in the x, y, and z directions.|
| minimumClock | number | `0.0` | `optional` The minimum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. |
| maximumClock | number | `2*PI` | `optional` The maximum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. |
Expand Down
21 changes: 14 additions & 7 deletions website/docs/en-US/geometries/vc-geometry-frustum.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
<!--
* @Author: ly
* @Date: 2022-09-21 09:41:12
* @LastEditors: ly
* @LastEditTime: 2022-09-21 11:01:55
* @FilePath: \vue-cesium\website\docs\en-US\geometries\vc-geometry-frustum.md
-->
## VcGeometryFrustum

Loading a frustum geometry. It is equivalent to initializing a `Cesium.FrustumGeometry` instance.
Expand Down Expand Up @@ -134,10 +141,10 @@ Basic usage of the VcGeometryFrustum component.

| Name | Type | Default | Description |
| ------------ | ------------- | ------- | ------------------------------------------------ |
| frustum | Object | | `optional` The frustum. |
| origin | Object\|Array | | `optional` The origin of the frustum. |
| orientation | Object\|Array | | `optional` The orientation of the frustum. |
| vertexFormat | Object | | `optional` The vertex attributes to be computed. |
| frustum | Cesium.PerspectiveFrustum \| Cesium.OrthographicFrustum | | `optional` The frustum. |
| origin | VcPosition\|Array | | `optional` The origin of the frustum. |
| orientation | Cesium.Quaternion\|Array | | `optional` The orientation of the frustum. |
| vertexFormat | Cesium.VertexFormat | | `optional` The vertex attributes to be computed. |

### Events

Expand All @@ -157,9 +164,9 @@ Loading a frustum geometry outline. It is equivalent to initializing a `Cesium.F

| Name | Type | Default | Description |
| ----------- | ------------- | ------- | ------------------------------------------ |
| frustum | Object | | `optional` The frustum. |
| origin | Object\|Array | | `optional` The origin of the frustum. |
| orientation | Object\|Array | | `optional` The orientation of the frustum. |
| frustum | Cesium.PerspectiveFrustum \| Cesium.OrthographicFrustum | | `optional` The frustum. |
| origin | VcPosition\|Array | | `optional` The origin of the frustum. |
| orientation | Cesium.Quaternion\|Array | | `optional` The orientation of the frustum. |

### VcGeometryFrustumOutline Events

Expand Down
Loading

0 comments on commit 60e47d3

Please sign in to comment.