Files
coopgo/node_modules/ol/format/Polyline.d.ts
sgauthier 6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
planning
2024-10-14 09:15:30 +02:00

167 lines
5.9 KiB
TypeScript

/**
* Encode a list of n-dimensional points and return an encoded string
*
* Attention: This function will modify the passed array!
*
* @param {Array<number>} numbers A list of n-dimensional points.
* @param {number} stride The number of dimension of the points in the list.
* @param {number} [opt_factor] The factor by which the numbers will be
* multiplied. The remaining decimal places will get rounded away.
* Default is `1e5`.
* @return {string} The encoded string.
* @api
*/
export function encodeDeltas(numbers: Array<number>, stride: number, opt_factor?: number | undefined): string;
/**
* Decode a list of n-dimensional points from an encoded string
*
* @param {string} encoded An encoded string.
* @param {number} stride The number of dimension of the points in the
* encoded string.
* @param {number} [opt_factor] The factor by which the resulting numbers will
* be divided. Default is `1e5`.
* @return {Array<number>} A list of n-dimensional points.
* @api
*/
export function decodeDeltas(encoded: string, stride: number, opt_factor?: number | undefined): Array<number>;
/**
* Encode a list of floating point numbers and return an encoded string
*
* Attention: This function will modify the passed array!
*
* @param {Array<number>} numbers A list of floating point numbers.
* @param {number} [opt_factor] The factor by which the numbers will be
* multiplied. The remaining decimal places will get rounded away.
* Default is `1e5`.
* @return {string} The encoded string.
* @api
*/
export function encodeFloats(numbers: Array<number>, opt_factor?: number | undefined): string;
/**
* Decode a list of floating point numbers from an encoded string
*
* @param {string} encoded An encoded string.
* @param {number} [opt_factor] The factor by which the result will be divided.
* Default is `1e5`.
* @return {Array<number>} A list of floating point numbers.
* @api
*/
export function decodeFloats(encoded: string, opt_factor?: number | undefined): Array<number>;
/**
* Encode a list of signed integers and return an encoded string
*
* Attention: This function will modify the passed array!
*
* @param {Array<number>} numbers A list of signed integers.
* @return {string} The encoded string.
*/
export function encodeSignedIntegers(numbers: Array<number>): string;
/**
* Decode a list of signed integers from an encoded string
*
* @param {string} encoded An encoded string.
* @return {Array<number>} A list of signed integers.
*/
export function decodeSignedIntegers(encoded: string): Array<number>;
/**
* Encode a list of unsigned integers and return an encoded string
*
* @param {Array<number>} numbers A list of unsigned integers.
* @return {string} The encoded string.
*/
export function encodeUnsignedIntegers(numbers: Array<number>): string;
/**
* Decode a list of unsigned integers from an encoded string
*
* @param {string} encoded An encoded string.
* @return {Array<number>} A list of unsigned integers.
*/
export function decodeUnsignedIntegers(encoded: string): Array<number>;
/**
* Encode one single unsigned integer and return an encoded string
*
* @param {number} num Unsigned integer that should be encoded.
* @return {string} The encoded string.
*/
export function encodeUnsignedInteger(num: number): string;
export default Polyline;
export type Options = {
/**
* The factor by which the coordinates values will be scaled.
*/
factor?: number | undefined;
/**
* Layout of the
* feature geometries created by the format reader.
*/
geometryLayout?: {
XY: string;
XYZ: string;
XYM: string;
XYZM: string;
} | undefined;
};
/**
* @typedef {Object} Options
* @property {number} [factor=1e5] The factor by which the coordinates values will be scaled.
* @property {GeometryLayout} [geometryLayout='XY'] Layout of the
* feature geometries created by the format reader.
*/
/**
* @classdesc
* Feature format for reading and writing data in the Encoded
* Polyline Algorithm Format.
*
* When reading features, the coordinates are assumed to be in two dimensions
* and in [latitude, longitude] order.
*
* As Polyline sources contain a single feature,
* {@link module:ol/format/Polyline~Polyline#readFeatures} will return the
* feature in an array.
*
* @api
*/
declare class Polyline extends TextFeature {
/**
* @param {Options} [opt_options] Optional configuration object.
*/
constructor(opt_options?: Options | undefined);
/**
* @type {import("../proj/Projection.js").default}
*/
dataProjection: import("../proj/Projection.js").default;
/**
* @private
* @type {number}
*/
private factor_;
/**
* @private
* @type {import("../geom/GeometryLayout").default}
*/
private geometryLayout_;
/**
* @param {import("../Feature.js").default<LineString>} feature Features.
* @param {import("./Feature.js").WriteOptions} [opt_options] Write options.
* @protected
* @return {string} Text.
*/
protected writeFeatureText(feature: import("../Feature.js").default<LineString>, opt_options?: import("./Feature.js").WriteOptions | undefined): string;
/**
* @param {Array<import("../Feature.js").default<LineString>>} features Features.
* @param {import("./Feature.js").WriteOptions} [opt_options] Write options.
* @protected
* @return {string} Text.
*/
protected writeFeaturesText(features: Array<import("../Feature.js").default<LineString>>, opt_options?: import("./Feature.js").WriteOptions | undefined): string;
/**
* @param {LineString} geometry Geometry.
* @param {import("./Feature.js").WriteOptions} [opt_options] Write options.
* @protected
* @return {string} Text.
*/
protected writeGeometryText(geometry: LineString, opt_options?: import("./Feature.js").WriteOptions | undefined): string;
}
import TextFeature from "./TextFeature.js";
import LineString from "../geom/LineString.js";
//# sourceMappingURL=Polyline.d.ts.map