### Example: Primitive Collection Management (JavaScript) Demonstrates how to add, get, and toggle the visibility of primitives within a Cesium PrimitiveCollection, applicable to CGeoJSONLayer. ```javascript var primitives = scene.primitives; var length = primitives.length; for (var i = 0; i < length; ++i) { var p = primitives.get(i); p.show = !p.show; } ``` -------------------------------- ### QEGridDataProvider Constructor Initializes a new instance of the QEGridDataProvider class. ```APIDOC ## new QEGridDataProvider ### Description Constructs a new QEGridDataProvider. ### Method CONSTRUCTOR ### Parameters * **buffer**: ArrayBuffer - Required - Data buffer. * **options**: IQEGridDataProviderOptions - Optional - Configuration options for the data provider. ### Returns QEGridDataProvider - The instantiated QEGridDataProvider object. ``` -------------------------------- ### ResourceService - Constructor Initializes a new instance of ResourceService. ```APIDOC ## ResourceService Constructor ### Description Initializes a new instance of the ResourceService. ### Method ``` new ResourceService() ``` ### Returns - ResourceService: A new instance of ResourceService. ``` -------------------------------- ### Handle Events Once (Example) Listens for a specific event type and executes a callback function only once before removing the listener. This is useful for one-time setup or actions. ```javascript map.once('click', function() { console.log('Clicked once!'); }); ``` -------------------------------- ### CView Constructor Initializes a new instance of the CView class. ```APIDOC ## new CView(container: string | Element, options?: ICViewOptions): CView ### Description Constructs a CView instance. ### Method CONSTRUCTOR ### Parameters #### Path Parameters - **container** (string | Element) - Required - The container element or its ID. - **options** (ICViewOptions) - Optional - Configuration options for the CView. ### Returns CView - An instance of the CView class. ``` -------------------------------- ### Get Zoom Level from Scale Calculates the zoom level corresponding to a given scale factor. It can optionally take a starting zoom level for reference. ```typescript getScaleZoom(scale: number, fromZoom?: number): number ``` -------------------------------- ### LAxisLayer Constructor Example Demonstrates the instantiation of LAxisLayer with optional options. This is the primary way to create an instance of the LAxisLayer class. ```typescript new LAxisLayer(options?: ILAxisLayerOptions): LAxisLayer ``` -------------------------------- ### Get Zoom Level from Zoom Calculates the scale factor for a target zoom level, optionally relative to a starting zoom level. This is useful for understanding zoom changes. ```typescript getZoomScale(toZoom: number, fromZoom?: number): number ``` -------------------------------- ### Initialize from URL Creates a GrayImageGridDataProvider instance from a URL. It requires the URL, a boolean indicating if it's video data, and provider options. Returns a Promise resolving to GrayImageGridDataProvider. ```typescript fromURL(url: string, isVideo: boolean, options: IGrayImageGridDataProviderOptions): Promise ``` -------------------------------- ### Get Geometry Instance Attributes Example (JavaScript) Retrieves modifiable per-instance attributes for a GeometryInstance, allowing updates to color, visibility, distance display conditions, and offsets. ```javascript var attributes = primitive.getGeometryInstanceAttributes('an id'); attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA); attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true); attributes.distanceDisplayCondition = Cesium.DistanceDisplayConditionGeometryInstanceAttribute.toValue(100.0, 10000.0); attributes.offset = Cesium.OffsetGeometryInstanceAttribute.toValue(Cartesian3.IDENTITY); ``` -------------------------------- ### Get Geometry Instance Attributes (JavaScript) Retrieves modifiable per-instance attributes for a GeometryInstance. It takes an ID as input and returns the typed array of attributes or undefined if the instance is not found. Example usage shows how to modify color, visibility, distance display condition, and offset. ```javascript var attributes = primitive.getGeometryInstanceAttributes('an id'); attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA); attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true); attributes.distanceDisplayCondition = Cesium.DistanceDisplayConditionGeometryInstanceAttribute.toValue(100.0, 10000.0); attributes.offset = Cesium.OffsetGeometryInstanceAttribute.toValue(Cartesian3.IDENTITY); ``` -------------------------------- ### SimpleDapInfoParser Constructor Initializes a new instance of the SimpleDapInfoParser class. ```APIDOC ## Constructors ### constructor * `new SimpleDapInfoParser(input: any): SimpleDapInfoParser` #### Parameters * ##### input: any #### Returns SimpleDapInfoParser ``` -------------------------------- ### LWindLayer Constructor Initializes a new LWindLayer instance with optional configuration options. ```APIDOC ## new LWindLayer ### Description Constructs a new wind field layer. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **options** (ILWindLayerOptions) - Optional - Construction parameters. ### Request Example ```json { "options": {} } ``` ### Response #### Success Response (200) - **LWindLayer** - An instance of the LWindLayer. #### Response Example ```json { "layer": "instance_of_LWindLayer" } ``` ``` -------------------------------- ### Get Map Container Element Retrieves the HTML element that serves as the container for the map. This can be used for direct DOM manipulation or to get dimensions. ```typescript getContainer(): HTMLElement ``` -------------------------------- ### QEGridDataProvider Constructor Initializes a new instance of QEGridDataProvider with provided data buffer and optional grid options. ```typescript new QEGridDataProvider(buffer: ArrayBuffer, options?: IQEGridDataProviderOptions): QEGridDataProvider ``` -------------------------------- ### Example Resource Configuration Structure This example demonstrates the structure of predefined resource configurations, showing how to define resource types like 'featureStyles' and 'images', each with specific resource IDs. ```typescript //这里是资源的类型 featureStyles:{ //这里是资源的ID style1:{ }, style2:{ } }, images:{ img1:"", img2:"" } ``` -------------------------------- ### Array2DGridDataProvider Methods (Data Access) Includes methods to retrieve grid data, such as 'allGrids' to get all dimensions of data, 'center' to get center coordinates, and 'getGrid' for specific grid fields. ```typescript allGrids(): GridData[][] center(): { lat: number; lon: number; z: number } centerLat(): number centerLon(): number centerZ(): number getGrid(dim?: any, level?: any): GridData ``` -------------------------------- ### GrayImageGridDataProvider Constructor Documentation for the constructor of the GrayImageGridDataProvider class, used to initialize a new instance. ```APIDOC ## GrayImageGridDataProvider Constructor Initializes a new instance of the `GrayImageGridDataProvider` class. ### Signature ```typescript new GrayImageGridDataProvider(source: TexImageSource, options: IGrayImageGridDataProviderOptions): GrayImageGridDataProvider ``` ### Parameters * **source** (`TexImageSource`): The source for the image data. * **options** (`IGrayImageGridDataProviderOptions`): Options for the grid data provider. ### Returns * `GrayImageGridDataProvider`: A new instance of the `GrayImageGridDataProvider`. ### Description Constructs a QEGridDataProvider. ### Member Of `QEGridDataProvider` ``` -------------------------------- ### Get All Features Retrieves all vector features available through the provider. ```APIDOC ## GET /features ### Description Retrieves all vector features managed by the provider. ### Method GET ### Endpoint `/features` ### Response #### Success Response (200) - **FeatureCollection** - A collection of all vector features. #### Response Example ```json { "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "type": "Point", "coordinates": [102.0, 0.5] }, "properties": { "prop0": "value0" } } ] } ``` ``` -------------------------------- ### BitmapColorScaleGL Constructor Initializes a new instance of the BitmapColorScaleGL class. ```APIDOC ## new BitmapColorScaleGL(options: IBitmapColorScaleFieldGLOptions): BitmapColorScaleGL ### Description Constructs a BitmapColorScaleGL object. ### Method CONSTRUCTOR ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **options** (IBitmapColorScaleFieldGLOptions) - Required - Options for the bitmap color scale. ### Request Example ```json { "options": {} } ``` ### Response #### Success Response (200) - **BitmapColorScaleGL** - The newly created BitmapColorScaleGL instance. #### Response Example ```json { "instance": "BitmapColorScaleGL" } ``` ``` -------------------------------- ### GridBaseStyle Constructor Initializes a new instance of the GridBaseStyle class. ```APIDOC ## new GridBaseStyle() GridBaseStyle ### Description Initializes a new instance of the GridBaseStyle class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Type Parameters * #### T #### Returns GridBaseStyle ### Request Example ```json {} ``` ### Response Example ```json { "example": "GridBaseStyle instance" } ``` ``` -------------------------------- ### GET /api/weather/getS Retrieves the wind speed field. ```APIDOC ## GET /api/weather/getS ### Description Retrieves the wind speed field. ### Method GET ### Endpoint /api/weather/getS ### Parameters #### Query Parameters - **dim** (any) - Optional - Dimension identifier. - **level** (any) - Optional - Height level identifier. ### Returns - **GridData**: Grid data representing wind speed. ``` -------------------------------- ### Static Method: fromUrl Creates a TifGridDataProvider instance by loading data from a URL. ```APIDOC ## Static fromUrl ### Description Creates a TifGridDataProvider instance by fetching data from a specified URL. ### Method GET (Assumed, as data is being fetched from a URL. Not specified in input, so using a common convention) ### Endpoint N/A (This is a static class method, not an HTTP endpoint) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **url** (string) - Required - The URL to fetch the TIF grid data from. - **options** (ITifGridDataProviderOptions) - Optional - Options for loading the data provider. ### Request Example ```javascript const url = 'http://example.com/data/grid.tif'; const options = { /* ... options ... */ }; TifGridDataProvider.fromUrl(url, options) .then(gridDataProvider => { console.log('TifGridDataProvider created from URL:', gridDataProvider); }) .catch(error => { console.error('Error creating TifGridDataProvider from URL:', error); }); ``` ### Response #### Success Response (200) - **Promise** (Promise) - A promise that resolves with the TifGridDataProvider instance. #### Response Example ```json { "status": "success", "data": { /* TifGridDataProvider instance details */ } } ``` ``` -------------------------------- ### CGeoJSONLayer.length Property Gets the number of primitives currently in the CGeoJSONLayer collection. ```typescript length: number ``` -------------------------------- ### Event Handling - once Behaves as on(...), except the listener will only get fired once and then removed. ```APIDOC ## Event Handling - once ### Description Behaves as on(...), except the listener will only get fired once and then removed. ### Method GET ### Endpoint /event/once ### Parameters #### Query Parameters - **type** (string) - Required - The type of event to listen for. - **fn** (LocationEventHandlerFn | LeafletMouseEventHandlerFn | LeafletKeyboardEventHandlerFn | ZoomAnimEventHandlerFn | DragEndEventHandlerFn | TileEventHandlerFn | TileErrorEventHandlerFn | LeafletEventHandlerFnMap) - Required - The function to call when the event is fired. - **context** (any) - Optional - The context for the event handler. ### Response #### Success Response (200) - **layer** (LCanvas2DGridBaseLayer) - The layer instance. #### Response Example { "layer": "LCanvas2DGridBaseLayer" } ``` -------------------------------- ### PixelLayerStyle Class Documentation for the PixelLayerStyle class, including its constructor, properties, and methods. ```APIDOC ## Class PixelLayerStyle 格点填色图层样式 ### Hierarchy * GridGLBaseStyle * PixelLayerStyle * PixelLayerStyle3D ## Constructors ### constructor * new PixelLayerStyle(options: IPixelLayerStyleOptions): PixelLayerStyle * 构建格点填色图层 #### Parameters * ##### options: IPixelLayerStyleOptions 构造参数 #### Returns PixelLayerStyle ## Properties ### colorScale colorScale: BitmapColorScaleGL bitmap形式的GL色例 memberof PixelLayerStyle ### fillColor fillColor: StopRules 格点颜色 memberof PixelLayerStyle ### fillMode fillMode: GridDataGLFillMode 显示方式 memberof PixelLayerStyle ### Optional fillModeForLine fillModeForLine?: shaded1 | shaded2 用于GPU等值线的色斑图模式，默认是shaded1。 memberof PixelLayerStyle ### globalOpacity globalOpacity: number 全局透明度，如果颜色中有透明度，最终透明度是全局透明度*颜色中的透明度 ### lineColor lineColor: number[] 等值线颜色。不配置则使用填色的调色板。 memberof PixelLayerStyle ### lineWidth lineWidth: number 等值线的粗细，建议不超过5。默认为1.5px。此等值线不支持标签显示，仅供粗略显示或者动画显示。分析级别的等值线可以使用tracingService中的算法生成。 memberof PixelLayerStyle ### maskLineStyle maskLineStyle: PolylineStyle 用于掩膜的线条样式（主要是设置线条宽度，可以为函数） ### optimizedInterp optimizedInterp: boolean 是否开启插值优化，默认是，如果出现缺测值和正常值之间的插值异常，请关闭，或者在调色配置中设置合理的分级规则（将一异常数据颜色设置为透明） ### pixelRatio pixelRatio: number Pixel2方式渲染的时候，数据插值的系数，范围为[0,1]，默认为0.5。 memberof PixelLayerStyle ### Optional showLine showLine?: boolean 是否显示等值线。默认为不显示。此等值线不支持标签显示，仅供粗略显示或者动画显示。分析级别的等值线可以使用tracingService中的算法生成。 等值线与fillMode shaded可以完全吻合。 memberof PixelLayerStyle ### Optional showRelief showRelief?: boolean 是否启用浮雕效果，默认false ### Static DefaultOptions DefaultOptions: IPixelLayerStyleOptions = ... 默认配置 ## Methods ### clearCaches * clearCaches(): void * 清空缓存 #### Returns void ### getPlaneOptions * getPlaneOptions(val: any, cache: any): IPixelLayerStyleOptions * #### Parameters * ##### val: any 格点值。对该图层无效 * ##### cache: any 是否缓存。对该图层无效。 #### Returns IPixelLayerStyleOptions 可直接使用的配置对象 ### isStyle * isStyle(): boolean * 表名当前的类是否是样式相关类。该类永远返回true memberof StyleBaseClass #### Returns boolean ### update * update(options: IPixelLayerStyleOptions, reinit?: boolean): void * 对当前样式对象使用新的参数进行更新 memberof StyleBaseClass #### Parameters * ##### options: IPixelLayerStyleOptions 新的参数 * ##### reinit: boolean = false #### Returns void ``` -------------------------------- ### Event Handling - on Behaves as on(...), except the listener will only get fired once and then removed. ```APIDOC ## Event Handling - on ### Description Behaves as on(...), except the listener will only get fired once and then removed. ### Method GET ### Endpoint /event/on ### Parameters #### Query Parameters - **type** (string) - Required - The type of event to listen for. - **fn** (LocationEventHandlerFn | LeafletMouseEventHandlerFn | LeafletKeyboardEventHandlerFn | ZoomAnimEventHandlerFn | DragEndEventHandlerFn | TileEventHandlerFn | TileErrorEventHandlerFn | LeafletEventHandlerFnMap) - Required - The function to call when the event is fired. - **context** (any) - Optional - The context for the event handler. ### Response #### Success Response (200) - **layer** (LCanvas2DGridBaseLayer) - The layer instance. #### Response Example { "layer": "LCanvas2DGridBaseLayer" } ``` -------------------------------- ### Constructor for LGeoJSONLayer Details on how to construct an LGeoJSONLayer instance, including parameters and return type. ```APIDOC ## Constructors ### constructor * new LGeoJSONLayer(options?: ILGeoJSONLayerOptions): LGeoJSONLayer * 构建 LGeoJSONLayer #### Parameters * ##### Optional options: ILGeoJSONLayerOptions #### Returns LGeoJSONLayer ``` -------------------------------- ### Get Saturation Component Retrieves the saturation component of the Spectra color. ```typescript const saturationValue = spectraInstance.saturation(); ``` -------------------------------- ### LDistanceMapTool Class Documentation for the LDistanceMapTool class, including its constructor, properties, and methods. ```APIDOC ## Class LDistanceMapTool ### Description Provides functionality for drawing and managing geometric shapes on a map. ### Hierarchy * LVectorMapTool * LDistanceMapTool ### Constructors #### constructor(options?: ILDistanceMapToolOptions) * Creates an instance of LDistanceMapTool. * **Parameters** * `options` (ILDistanceMapToolOptions) - Optional configuration options for the tool. * **Returns** LDistanceMapTool ### Properties #### options * **options** (IVectorMapToolOptions) - Configuration options for the map tool. #### Static EventTypes * **EventTypes**: An object containing event names for drawing. * `drawFinish`: string - Message name when drawing is completed. * `pointAdd`: string - Message name when a point is added during drawing. #### Static PointDownAsDragTime * **PointDownAsDragTime**: number = 200 * The duration in milliseconds before a mouse down event is considered a drag, preventing drawing response. Default is 500ms. ### Methods #### addEventParent(obj: any) * **Parameters** * `obj` (any) - The object to add as an event parent. * **Returns** LDistanceMapTool #### begin(properties?: any) * Triggers the drawing tool. * **Parameters** * `properties` (any) - Optional properties to initialize the drawing. * **Returns** void #### clear() * Clears all content generated by the tool. * **Returns** void #### end() * Ends the current drawing tool session. * **Returns** void #### fire(type: any, data: IEventData, propagate?: any) * **Parameters** * `type` (any) - The type of event to fire. * `data` (IEventData) - The data associated with the event. * `propagate` (any) - Optional flag to propagate the event. * **Returns** LDistanceMapTool #### getGeoJSON(): GeoJsonObject * Retrieves the drawn features in GeoJSON format. * **Returns** GeoJsonObject - The GeoJSON representation of the drawn features. #### listens(type: any, propagate?: any) * **Parameters** * `type` (any) - The event type to check for. * `propagate` (any) - Optional flag for propagation. * **Returns** boolean - True if the tool is listening for the event, false otherwise. #### lock() * Locks the tool, preventing further interactions. * **Returns** LDistanceMapTool #### off(types: any, fn: any, context?: any) * Removes event listeners. * **Parameters** * `types` (any) - The event types to remove listeners for. * `fn` (any) - The function to remove. * `context` (any) - Optional context for the listener. * **Returns** LDistanceMapTool #### on(types: any, fn: (event: IEventData) => void, context?: any) * Adds event listeners. * **Parameters** * `types` (any) - The event types to listen for. * `fn` ((event: IEventData) => void) - The callback function to execute when the event is fired. It receives an `IEventData` object. * `context` (any) - Optional context for the listener. * **Returns** LDistanceMapTool #### once(types: any, fn: (event: IEventData) => void, context?: any) * Adds a one-time event listener. * **Parameters** * `types` (any) - The event types to listen for. * `fn` ((event: IEventData) => void) - The callback function to execute once. It receives an `IEventData` object. * `context` (any) - Optional context for the listener. * **Returns** LDistanceMapTool #### pick(pt: { x: number; y: number }) * Picks a drawing object on the map at the specified point. * **Parameters** * `pt` ({ x: number; y: number }) - The point at which to pick the object. * `x` (number) - The x-coordinate of the point. * `y` (number) - The y-coordinate of the point. * **Returns** { key: string; properties?: any; shape: PlotShapeBase } * `key` (string) - The identifier of the picked object. * `properties` (any) - Optional properties of the picked object. * `shape` (PlotShapeBase) - The shape of the picked object. #### removeEventParent(obj: any) * **Parameters** * `obj` (any) - The object to remove as an event parent. * **Returns** LDistanceMapTool #### setMap(map: any) * Sets the map instance for the tool. * **Parameters** * `map` (any) - The map instance. * **Returns** void #### unlock(fireLocked?: boolean) * Unlocks the tool. * **Parameters** * `fireLocked` (boolean = true) - Optional flag to fire locked events. * **Returns** void #### updateDrawType(drawType: string) * Updates the current drawing type. * **Parameters** * `drawType` (string) - The new drawing type. * **Returns** void ``` -------------------------------- ### Get RGB Number Returns the color represented as an RGB number. ```typescript const rgbNumber = spectraInstance.rgbNumber(); // e.g., 16711680 for red ``` -------------------------------- ### BinaryGridDataProvider Methods A list of methods available for interacting with grid data. ```APIDOC ## Methods ### addEventParent * `addEventParent(obj: any): BinaryGridDataProvider` * Parameters: * `obj` (any): The object to add as an event parent. * Returns: `BinaryGridDataProvider` ### allGrids * `allGrids(): GridData[][]` * Description: Retrieves all dimension data within the current data accessor. * Returns: `GridData[][]` ### center * `center(): { lat: number; lon: number; z: number }` * Returns: `{ lat: number; lon: number; z: number }` ### centerLat * `centerLat(): number` * Returns: `number` ### centerLon * `centerLon(): number` * Returns: `number` ### centerZ * `centerZ(): number` * Returns: `number` ### fire * `fire(type: any, data: IEventData, propagate?: any): BinaryGridDataProvider` * Parameters: * `type` (any): The type of the event. * `data` (IEventData): The data associated with the event. * `propagate` (any, optional): Whether to propagate the event. * Returns: `BinaryGridDataProvider` ### getGrid * `getGrid(dim?: any, level?: any): GridData` * Description: Retrieves a two-dimensional grid. * Parameters: * `dim` (any, optional): The dimension to retrieve. * `level` (any, optional): The level to retrieve. * Returns: `GridData` ### getIntTIdx * `getIntTIdx(): number` * Description: Gets the current effective integer time index. * Returns: `number` ### getIntZIdx * `getIntZIdx(): number` * Description: Gets the current effective integer height level index. * Returns: `number` ### listens * `listens(type: any, propagate?: any): boolean` * Parameters: * `type` (any): The type of event to listen for. * `propagate` (any, optional): Whether to propagate the event. * Returns: `boolean` ### lock * `lock(): BinaryGridDataProvider` * Returns: `BinaryGridDataProvider` ### off * `off(types: any, fn: any, context?: any): BinaryGridDataProvider` * Parameters: * `types` (any): The types of events to stop listening to. * `fn` (any): The function to remove. * `context` (any, optional): The context for the function. * Returns: `BinaryGridDataProvider` ### offActiveGridUpdated * `offActiveGridUpdated(cb: (() => void)): IGridDataProvider` * Description: Cancels listening to messages when the grid at the current time and height index changes. * Parameters: * `cb` ((): void): The callback function to remove. * Returns: `IGridDataProvider` ### offIntTChanged * `offIntTChanged(cb: (() => void)): IGridDataProvider` * Description: Cancels listening to messages when the integer part of the time changes. * Parameters: * `cb` ((): void): The callback function to remove. * Returns: `IGridDataProvider` ### offIntTZChanged * `offIntTZChanged(cb: (() => void)): IGridDataProvider` * Description: Cancels listening to messages when the integer time and height change. * Parameters: * `cb` ((): void): The callback function to remove. * Returns: `IGridDataProvider` ### offIntZChanged * `offIntZChanged(cb: (() => void)): IGridDataProvider` * Description: Cancels listening to messages when the integer part of the height changes. * Parameters: * `cb` ((): void): The callback function to remove. * Returns: `IGridDataProvider` ### offTChanged * `offTChanged(cb: (() => void)): IGridDataProvider` * Description: Cancels listening to messages when the time changes. * Parameters: * `cb` ((): void): The callback function to remove. * Returns: `IGridDataProvider` ### offTZChanged * `offTZChanged(cb: (() => void)): IGridDataProvider` * Description: Cancels listening to messages when the time and height change. * Parameters: * `cb` ((): void): The callback function to remove. * Returns: `IGridDataProvider` ### offZChanged * `offZChanged(cb: (() => void)): IGridDataProvider` * Description: Cancels listening to messages when the height changes. * Parameters: * `cb` ((): void): The callback function to remove. * Returns: `IGridDataProvider` ### on * `on(type: any, fn: any, context?: any): BinaryGridDataProvider` * Parameters: * `type` (any): The type of event to listen for. * `fn` (any): The function to call when the event occurs. * `context` (any, optional): The context for the function. * Returns: `BinaryGridDataProvider` ### onActiveGridUpdated * `onActiveGridUpdated(cb: (() => void)): IGridDataProvider` * Description: Listens to messages when the grid at the current time and height index changes. * Parameters: * `cb` ((): void): The callback function to execute. * Returns: `IGridDataProvider` ### onIntTChanged * `onIntTChanged(cb: (() => void)): IGridDataProvider` * Description: Listens to messages when the integer part of the time changes. * Parameters: * `cb` ((): void): The callback function to execute. * Returns: `IGridDataProvider` ### onIntTZChanged * `onIntTZChanged(cb: (() => void)): IGridDataProvider` * Description: Listens to messages when the integer time and height change. * Parameters: * `cb` ((): void): The callback function to execute. * Returns: `IGridDataProvider` ### onIntZChanged * `onIntZChanged(cb: (() => void)): IGridDataProvider` * Description: Listens to messages when the integer part of the height changes. * Parameters: * `cb` ((): void): The callback function to execute. * Returns: `IGridDataProvider` ### onTChanged * `onTChanged(cb: (() => void)): IGridDataProvider` * Description: Listens to messages when the time changes. * Parameters: * `cb` ((): void): The callback function to execute. * Returns: `IGridDataProvider` ### onTZChanged * `onTZChanged(cb: (() => void)): IGridDataProvider` * Description: Listens to messages when the time and height change. * Parameters: * `cb` ((): void): The callback function to execute. * Returns: `IGridDataProvider` ### onZChanged * `onZChanged(cb: (() => void)): IGridDataProvider` * Description: Listens to messages when the height changes. * Parameters: * `cb` ((): void): The callback function to execute. * Returns: `IGridDataProvider` ### once * `once(type: any, fn: any, context?: any): BinaryGridDataProvider` * Parameters: * `type` (any): The type of event to listen for. * `fn` (any): The function to call once when the event occurs. * `context` (any, optional): The context for the function. * Returns: `BinaryGridDataProvider` ### removeEventParent * `removeEventParent(obj: any): BinaryGridDataProvider` * Parameters: * `obj` (any): The object to remove as an event parent. * Returns: `BinaryGridDataProvider` ### unlock * `unlock(): BinaryGridDataProvider` * Returns: `BinaryGridDataProvider` ### updateGrid * `updateGrid(): BinaryGridDataProvider` * Returns: `BinaryGridDataProvider` ``` -------------------------------- ### Get Lightness Component Retrieves the lightness component of the Spectra color. ```typescript const lightnessValue = spectraInstance.lightness(); ``` -------------------------------- ### CimissStationFeatureProvider Constructor Initializes a new instance of the CimissStationFeatureProvider class. ```APIDOC ## new CimissStationFeatureProvider() ### Description Constructs a new CimissStationFeatureProvider. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "cimissJson": {}, "options": {} } ``` ### Response #### Success Response (200) Returns an instance of CimissStationFeatureProvider. #### Response Example ```json { "instance": "CimissStationFeatureProvider" } ``` ``` -------------------------------- ### Static fromURL API Creates a GrayImageGridDataProvider instance from a URL. ```APIDOC ## Static fromURL ### Description Creates a GrayImageGridDataProvider instance from a URL. ### Method Static method ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```javascript // Example usage: // GrayImageGridDataProvider.fromURL('http://example.com/data', false, options).then(provider => { ... }); ``` ### Response #### Success Response (200) - **Promise** - A promise that resolves with the GrayImageGridDataProvider instance. #### Response Example ```json { "Promise": "GrayImageGridDataProvider" } ``` ``` -------------------------------- ### Get Hue Component Retrieves the hue component of the Spectra color. ```typescript const hueValue = spectraInstance.hue(); ``` -------------------------------- ### BorderAxisTool Constructor Initializes a new instance of the BorderAxisTool with specified options. ```APIDOC ## new BorderAxisTool(options: IBorderAxisOptions) ### Description Initializes a new instance of the BorderAxisTool class. ### Method CONSTRUCTOR ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **options** (IBorderAxisOptions) - Required - The options for configuring the BorderAxisTool. - **label** (object) - Optional - Configuration for axis labels. - **fontSize** (string) - Optional - Font size for labels. - **visible** (boolean) - Optional - Whether labels are visible. - **majorTick** (object) - Optional - Configuration for major ticks. - **tickCount** (number) - Optional - Number of major ticks. - **tickLength** (number) - Optional - Length of major ticks. - **tickLine** (object) - Optional - Styling for major tick lines. - **lineWidth** (number) - Optional - Width of the tick line. - **visible** (boolean) - Optional - Whether tick lines are visible. - **minorTick** (object) - Optional - Configuration for minor ticks. - **tickCount** (number) - Optional - Number of minor ticks. - **tickLength** (number) - Optional - Length of minor ticks. - **tickLine** (object) - Optional - Styling for minor tick lines. - **lineWidth** (number) - Optional - Width of the tick line. - **visible** (boolean) - Optional - Whether tick lines are visible. - **visible** (boolean) - Optional - Whether the axis border is visible. ### Request Example ```json { "options": { "label": { "fontSize": "12px", "visible": true }, "majorTick": { "tickCount": 5, "tickLength": 10, "tickLine": { "lineWidth": 1, "visible": true } }, "minorTick": { "tickCount": 2, "tickLength": 5, "tickLine": { "lineWidth": 0.5, "visible": false } }, "visible": true } } ``` ### Response #### Success Response (200) - **BorderAxisTool** - An instance of the BorderAxisTool. #### Response Example ```json { "message": "BorderAxisTool initialized successfully." } ``` ``` -------------------------------- ### QEGridDataProvider Accessors Allows getting and setting the current time and Z indices. ```APIDOC ## QEGridDataProvider Accessors ### currentTIdx * **Description**: Gets or sets the current time dimension index. * **Getter**: Returns the current time dimension value (can be a decimal). * **Setter**: Sets the current time dimension value. If the index exceeds the data's time dimension, no operation is performed. * **Parameters**: * **idx**: number - The index to set. * **Returns**: void ### currentZIdx * **Description**: Gets or sets the current Z dimension index. * **Getter**: Returns the current height dimension value (can be a decimal). * **Setter**: Sets the current Z dimension index. No operation is performed if the index is out of bounds. * **Parameters**: * **idx**: number - The index to set. * **Returns**: void ``` -------------------------------- ### QEGridDataProvider Methods Provides various methods for interacting with grid data. ```APIDOC ## QEGridDataProvider Methods ### addEventParent * **Description**: Adds an event parent. * **Parameters**: * **obj**: any - The object to add as an event parent. * **Returns**: QEGridDataProvider ### allGrids * **Description**: Retrieves all dimension data within the current data accessor. * **Returns**: GridData[][] - An array of all grid data. ### center * **Description**: Gets the center coordinates (latitude, longitude, and Z). * **Returns**: { lat: number; lon: number; z: number } - An object containing the center coordinates. ### centerLat * **Description**: Gets the center latitude. * **Returns**: number ### centerLon * **Description**: Gets the center longitude. * **Returns**: number ### centerZ * **Description**: Gets the center Z value. * **Returns**: number ### fire * **Description**: Fires an event. * **Parameters**: * **type**: any - The type of event. * **data**: IEventData - The event data. * **propagate**: any - Optional propagation flag. * **Returns**: QEGridDataProvider ### getGrid * **Description**: Retrieves a 2D grid field. * **Parameters**: * **dim**: any - Optional dimension parameter. * **level**: any - Optional level parameter. * **Returns**: GridData ### getIntTIdx * **Description**: Gets the current effective integer time index. * **Returns**: number ### getIntZIdx * **Description**: Gets the current effective integer Z index. * **Returns**: number ### listens * **Description**: Checks if the provider is listening for a specific event type. * **Parameters**: * **type**: any - The event type to check. * **propagate**: any - Optional propagation flag. * **Returns**: boolean ### lock * **Description**: Locks the data accessor. * **Returns**: QEGridDataProvider ### off * **Description**: Removes an event listener. * **Parameters**: * **types**: any - The event types to remove. * **fn**: any - The listener function to remove. * **context**: any - Optional context for the listener. * **Returns**: QEGridDataProvider ### offActiveGridUpdated * **Description**: Detaches a callback that listens for changes in the grid data at the current time and Z indices. * **Parameters**: * **cb**: (() => void) - The callback function to detach. * **Returns**: IGridDataProvider ### offIntTChanged * **Description**: Detaches a callback that listens for changes in the integer time index. * **Parameters**: * **cb**: (() => void) - The callback function to detach. * **Returns**: IGridDataProvider ### offIntTZChanged * **Description**: Detaches a callback that listens for changes in the integer time and Z indices. * **Parameters**: * **cb**: (() => void) - The callback function to detach. * **Returns**: IGridDataProvider ### offIntZChanged * **Description**: Detaches a callback that listens for changes in the integer Z index. * **Parameters**: * **cb**: (() => void) - The callback function to detach. * **Returns**: IGridDataProvider ### offTChanged * **Description**: Detaches a callback that listens for changes in the time index. * **Parameters**: * **cb**: (() => void) - The callback function to detach. * **Returns**: IGridDataProvider ``` -------------------------------- ### Getting Layer Bounds Returns the geographic bounds (LatLngBounds) of the LMapboxGLLayer. ```typescript /// /** * Gets the bounds of the layer. * @returns The LatLngBounds object. */ function getBounds(): LatLngBounds; ``` -------------------------------- ### Getting Layer Attribution Retrieves the attribution string associated with the LMapboxGLLayer. ```typescript /// /** * Gets the attribution string for the layer. * @returns The attribution string. */ function getAttribution(): string; ``` -------------------------------- ### LPixelLayer Constructor Initializes a new instance of LPixelLayer with optional configuration options. ```APIDOC ## new LPixelLayer(options?: ILPixelLayerOptions) ### Description Constructs a pixel layer with optional configuration parameters. ### Method `new` ### Endpoint N/A (Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "options": { "pixelData": [ [0, 0, 255, 255], [255, 0, 0, 255] ], "bounds": [ [0, 0], [10, 10] ] } } ``` ### Response #### Success Response (200) Returns an instance of LPixelLayer. #### Response Example ```json { "instance": "LPixelLayer" } ``` ``` -------------------------------- ### GET /api/weather/getW Retrieves the W component of the wind field. ```APIDOC ## GET /api/weather/getW ### Description Retrieves the W component (vertical) of the wind field. ### Method GET ### Endpoint /api/weather/getW ### Parameters #### Query Parameters - **dim** (number) - Optional - Dimension identifier. - **level** (number) - Optional - Height level identifier. ### Returns - **GridData**: Grid data representing the W component of the wind. ``` -------------------------------- ### VolumeLayerStyle Constructor Initializes a new instance of the VolumeLayerStyle class with specified options. ```APIDOC ## new VolumeLayerStyle ### Description Initializes a new instance of the VolumeLayerStyle class. ### Method CONSTRUCTOR ### Parameters #### options: IVolumeLayerStyleOptions - **options** (IVolumeLayerStyleOptions) - Required - The options to initialize the VolumeLayerStyle with. ### Returns VolumeLayerStyle ### Returns Example ```json { "instance": "VolumeLayerStyle" } ``` ```