@itwin/core-common 3.4.0 → 3.4.1

package/lib/esm/AnalysisStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"AnalysisStyle.js","sourceRoot":"","sources":["../../src/AnalysisStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAgB,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAiC,MAAM,mBAAmB,CAAC;AAC5F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAgBtC;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IAQpC,gBAAgB;IAChB,YAAoB,WAAmB,EAAE,KAAK,GAAG,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAqC;QAC1D,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAmC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAChF,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAAgC;QAC5C,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC;IAC9E,CAAC;CACF;AAkBD;;;;;GAKG;AACH,MAAM,OAAO,qBAAqB;IAWhC,gBAAgB;IAChB,YAAoB,KAAiC;QACnD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,gBAAgB,GAAG,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpF,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAA+B;YACxC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;SAC3B,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,wBAAwB,CAAC,QAAQ,CAAC;YAClE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uDAAuD;IACvD,IAAW,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEvE,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjJ,CAAC;CACF;AA+BD,SAAS,qBAAqB,CAAC,KAAyB;IACtD,IAAI,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,MAAM;QACpC,OAAO,KAAK,CAAC;IAEf,MAAM,MAAM,GAAG,KAAiC,CAAC;IACjD,IAAI,SAAS,KAAK,MAAM,CAAC,uBAAuB,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB;QACxF,OAAO,KAAK,CAAC;IAEf,MAAM,MAAM,GAAuB;QACjC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;KAC3C,CAAC;IAEF,IAAI,SAAS,KAAK,MAAM,CAAC,uBAAuB,EAAE;QAChD,MAAM,CAAC,YAAY,GAAG;YACpB,WAAW,EAAE,MAAM,CAAC,uBAAuB;YAC3C,KAAK,EAAE,MAAM,CAAC,iBAAiB;SAChC,CAAC;KACH;IAED,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB,IAAI,SAAS,KAAK,MAAM,CAAC,WAAW,EAAE;QAC9E,MAAM,CAAC,MAAM,GAAG;YACd,WAAW,EAAE,MAAM,CAAC,iBAAiB;YACrC,KAAK,EAAE,MAAM,CAAC,WAAW;YACzB,gBAAgB,EAAE,MAAM,CAAC,sBAAsB;SAChD,CAAC;KACH;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,aAAa;IAoBxB,gBAAgB;IAChB,YAAoB,KAAyB;QAC3C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,KAAK,CAAC,YAAY;YACpB,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAE7E,IAAI,KAAK,CAAC,MAAM;YACd,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAtBD;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,SAAS,KAAK,KAAK,CAAC,iBAAiB;YAC/E,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAYD,qDAAqD;IAC9C,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,IAAI,KAAK,aAAa,CAAC,QAAQ;YACjC,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;YACtC,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,2GAA2G;IACpG,KAAK,CAAC,YAAgC;QAC3C,OAAO,aAAa,CAAC,QAAQ,CAAC;YAC5B,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,KAAoB;QAChC,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB;YACpD,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC;YAC1E,OAAO,KAAK,CAAC;aACV,IAAI,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,YAAa,CAAC;YAC1E,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,QAAQ,CAAC;YAClE,OAAO,KAAK,CAAC;QAEf,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC,CAAC;IAC9E,CAAC;;AAEsB,sBAAQ,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { Range1d, Range1dProps } from \"@itwin/core-geometry\";\r\nimport { ThematicGradientSettings, ThematicGradientSettingsProps } from \"./ThematicDisplay\";\r\nimport { Gradient } from \"./Gradient\";\r\n\r\n/** JSON representation of an [[AnalysisStyleDisplacement]].\r\n * @see [[AnalysisStyleProps.displacement]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleDisplacementProps {\r\n  /** See [[AnalysisStyleDisplacement.channelName]]. */\r\n  channelName: string;\r\n  /** See [[AnalysisStyleDisplacement.scale]].\r\n   * Default value: 1.\r\n   */\r\n  scale?: number;\r\n}\r\n\r\n/** Describes how an [[AnalysisStyle]] deforms a [Polyface]($core-geometry) by applying translation to its vertices.\r\n * @see [[AnalysisStyle.displacement]].\r\n * @public\r\n */\r\nexport class AnalysisStyleDisplacement {\r\n  /** The name of the [AuxChannel]($core-geometry) supplying the displacements to be applied to the vertices. */\r\n  public readonly channelName: string;\r\n  /** A scale applied to the displacements to adjust the magnitude of the effect.\r\n   * Default value: 1.\r\n   */\r\n  public readonly scale: number;\r\n\r\n  /** @internal */\r\n  private constructor(channelName: string, scale = 1) {\r\n    this.channelName = channelName;\r\n    this.scale = scale;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: AnalysisStyleDisplacementProps): AnalysisStyleDisplacement {\r\n    return new this(props.channelName, props.scale);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): AnalysisStyleDisplacementProps {\r\n    const props: AnalysisStyleDisplacementProps = { channelName: this.channelName };\r\n    if (this.scale !== 1)\r\n      props.scale = this.scale;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Return true if `this` is equivalent to `other`. */\r\n  public equals(other: AnalysisStyleDisplacement): boolean {\r\n    return this.channelName === other.channelName && this.scale === other.scale;\r\n  }\r\n}\r\n\r\n/** JSON representation of an [[AnalysisStyleThematic]].\r\n * @see [[AnalysisStyleProps.scalar]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleThematicProps {\r\n  /** See [[AnalysisStyleThematic.channelName]]. */\r\n  channelName: string;\r\n  /** See [[AnalysisStyleThematic.range]]. */\r\n  range: Range1dProps;\r\n  /** See [[AnalysisStyleThematic.thematicSettings]].\r\n   * Default value: [[ThematicGradientSettings.defaults]].\r\n   */\r\n  thematicSettings?: ThematicGradientSettingsProps;\r\n}\r\n\r\n/** Describes how an [[AnalysisStyle]] recolors [Polyface]($core-geometry) vertices by mapping values of type\r\n * [AuxChannelDataType.Scalar]($core-geometry) or [AuxChannelDataType.Distance]($core-geometry) supplied\r\n * by an [AuxChannel]($core-geometry) to colors supplied by a [[Gradient]] image.\r\n * @see [[AnalysisStyle.thematic]].\r\n * @public\r\n */\r\nexport class AnalysisStyleThematic {\r\n  /** The name of the [AuxChannel]($core-geometry) supplying the values from which the vertex colors are computed. */\r\n  public readonly channelName: string;\r\n  /** The minimum and maximum values that map to colors in the [[Gradient]] image. Vertices with values outside of\r\n   * this range are displayed with the gradient's margin color.\r\n   */\r\n  public readonly range: Readonly<Range1d>;\r\n  /** Settings used to produce the [[Gradient]] image. */\r\n  public readonly thematicSettings: ThematicGradientSettings;\r\n  private _gradient?: Gradient.Symb;\r\n\r\n  /** @internal */\r\n  private constructor(props: AnalysisStyleThematicProps) {\r\n    this.channelName = props.channelName;\r\n    this.range = Range1d.fromJSON(props.range);\r\n    this.thematicSettings = ThematicGradientSettings.fromJSON(props.thematicSettings);\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: AnalysisStyleThematicProps): AnalysisStyleThematic {\r\n    return new this(props);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): AnalysisStyleThematicProps {\r\n    const props: AnalysisStyleThematicProps = {\r\n      channelName: this.channelName,\r\n      range: this.range.toJSON(),\r\n    };\r\n\r\n    if (!this.thematicSettings.equals(ThematicGradientSettings.defaults))\r\n      props.thematicSettings = this.thematicSettings.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** The gradient computed from [[thematicSettings]]. */\r\n  public get gradient(): Gradient.Symb {\r\n    if (!this._gradient)\r\n      this._gradient = Gradient.Symb.createThematic(this.thematicSettings);\r\n\r\n    return this._gradient;\r\n  }\r\n\r\n  /** Return true if `this` is equivalent to `other`. */\r\n  public equals(other: AnalysisStyleThematic): boolean {\r\n    return this.channelName === other.channelName && this.range.isAlmostEqual(other.range) && this.thematicSettings.equals(other.thematicSettings);\r\n  }\r\n}\r\n\r\n/** JSON representation of an [[AnalysisStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleProps {\r\n  /** See [[AnalysisStyle.displacement]]. */\r\n  displacement?: AnalysisStyleDisplacementProps;\r\n  /** JSON representation of [[AnalysisStyle.thematic]].\r\n   * @note The name \"scalar\" is used instead of \"thematic\" for backwards compatibility.\r\n   */\r\n  scalar?: AnalysisStyleThematicProps;\r\n  /** See [[AnalysisStyle.normalChannelName]]. */\r\n  normalChannelName?: string;\r\n}\r\n\r\n/** At time of writing, the only iModel in existence that uses AnalysisStyle is the one created by the analysis-importer test app.\r\n * To avoid breaking existing saved views of that iModel, AnalysisStyle.fromJSON() continues  to accept the old JSON representation -\r\n * but that representation is not part of the public API.\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface LegacyAnalysisStyleProps {\r\n  displacementChannelName?: string;\r\n  scalarChannelName?: string;\r\n  normalChannelName?: string;\r\n  displacementScale?: number;\r\n  scalarRange?: Range1dProps;\r\n  scalarThematicSettings?: ThematicGradientSettingsProps;\r\n}\r\n\r\nfunction tryConvertLegacyProps(input: AnalysisStyleProps): AnalysisStyleProps {\r\n  if (input.displacement || input.scalar)\r\n    return input;\r\n\r\n  const legacy = input as LegacyAnalysisStyleProps;\r\n  if (undefined === legacy.displacementChannelName && undefined === legacy.scalarChannelName)\r\n    return input;\r\n\r\n  const output: AnalysisStyleProps = {\r\n    normalChannelName: input.normalChannelName,\r\n  };\r\n\r\n  if (undefined !== legacy.displacementChannelName) {\r\n    output.displacement = {\r\n      channelName: legacy.displacementChannelName,\r\n      scale: legacy.displacementScale,\r\n    };\r\n  }\r\n\r\n  if (undefined !== legacy.scalarChannelName && undefined !== legacy.scalarRange) {\r\n    output.scalar = {\r\n      channelName: legacy.scalarChannelName,\r\n      range: legacy.scalarRange,\r\n      thematicSettings: legacy.scalarThematicSettings,\r\n    };\r\n  }\r\n\r\n  return output;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], describes how to animate meshes in the view that have been augmented with\r\n * [PolyfaceAuxData]($core-geometry). The style specifies which channels to use, and can deform the meshes by\r\n * translating vertices and/or recolor vertices using [[ThematicDisplay]].\r\n * @see [[DisplayStyleSettings.analysisStyle]] to define the analysis style for a [DisplayStyle]($backend).\r\n * @see [[DisplayStyleSettings.analysisFraction]] to control playback of the animation.\r\n * @public\r\n */\r\nexport class AnalysisStyle {\r\n  public readonly displacement?: AnalysisStyleDisplacement;\r\n  public readonly thematic?: AnalysisStyleThematic;\r\n  /** If defined, the name of the [AuxChannel]($core-geometry) from which to obtain normal vectors for the vertices. */\r\n  public readonly normalChannelName?: string;\r\n\r\n  /** Create an analysis style from its JSON representation.\r\n   * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.\r\n   */\r\n  public static fromJSON(props?: AnalysisStyleProps): AnalysisStyle {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    props = tryConvertLegacyProps(props);\r\n    if (!props.displacement && !props.scalar && undefined === props.normalChannelName)\r\n      return this.defaults;\r\n\r\n    return new AnalysisStyle(props);\r\n  }\r\n\r\n  /** @internal */\r\n  private constructor(props: AnalysisStyleProps) {\r\n    this.normalChannelName = props.normalChannelName;\r\n    if (props.displacement)\r\n      this.displacement = AnalysisStyleDisplacement.fromJSON(props.displacement);\r\n\r\n    if (props.scalar)\r\n      this.thematic = AnalysisStyleThematic.fromJSON(props.scalar);\r\n  }\r\n\r\n  /** Convert this style to its JSON representation. */\r\n  public toJSON(): AnalysisStyleProps {\r\n    const props: AnalysisStyleProps = {};\r\n    if (this === AnalysisStyle.defaults)\r\n      return props;\r\n\r\n    if (this.displacement)\r\n      props.displacement = this.displacement.toJSON();\r\n\r\n    if (this.thematic)\r\n      props.scalar = this.thematic.toJSON();\r\n\r\n    if (undefined !== this.normalChannelName)\r\n      props.normalChannelName = this.normalChannelName;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Produce a copy of this style identical except for properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: AnalysisStyleProps): AnalysisStyle {\r\n    return AnalysisStyle.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  /** Return true if this style is equivalent to `other`. */\r\n  public equals(other: AnalysisStyle): boolean {\r\n    if (this.normalChannelName !== other.normalChannelName)\r\n      return false;\r\n\r\n    if ((undefined === this.displacement) !== (undefined === other.displacement))\r\n      return false;\r\n    else if (this.displacement && !this.displacement.equals(other.displacement!))\r\n      return false;\r\n\r\n    if ((undefined === this.thematic) !== (undefined === other.thematic))\r\n      return false;\r\n\r\n    return undefined === this.thematic || this.thematic.equals(other.thematic!);\r\n  }\r\n\r\n  public static readonly defaults = new AnalysisStyle({});\r\n}\r\n"]}
+{"version":3,"file":"AnalysisStyle.js","sourceRoot":"","sources":["../../src/AnalysisStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAgB,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAiC,MAAM,mBAAmB,CAAC;AAC5F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAgBtC;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IAQpC,gBAAgB;IAChB,YAAoB,WAAmB,EAAE,KAAK,GAAG,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAqC;QAC1D,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAmC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAChF,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAAgC;QAC5C,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC;IAC9E,CAAC;CACF;AAkBD;;;;;GAKG;AACH,MAAM,OAAO,qBAAqB;IAWhC,gBAAgB;IAChB,YAAoB,KAAiC;QACnD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,gBAAgB,GAAG,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpF,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAA+B;YACxC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;SAC3B,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,wBAAwB,CAAC,QAAQ,CAAC;YAClE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uDAAuD;IACvD,IAAW,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEvE,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjJ,CAAC;CACF;AA+BD,SAAS,qBAAqB,CAAC,KAAyB;IACtD,IAAI,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,MAAM;QACpC,OAAO,KAAK,CAAC;IAEf,MAAM,MAAM,GAAG,KAAiC,CAAC;IACjD,IAAI,SAAS,KAAK,MAAM,CAAC,uBAAuB,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB;QACxF,OAAO,KAAK,CAAC;IAEf,MAAM,MAAM,GAAuB;QACjC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;KAC3C,CAAC;IAEF,IAAI,SAAS,KAAK,MAAM,CAAC,uBAAuB,EAAE;QAChD,MAAM,CAAC,YAAY,GAAG;YACpB,WAAW,EAAE,MAAM,CAAC,uBAAuB;YAC3C,KAAK,EAAE,MAAM,CAAC,iBAAiB;SAChC,CAAC;KACH;IAED,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB,IAAI,SAAS,KAAK,MAAM,CAAC,WAAW,EAAE;QAC9E,MAAM,CAAC,MAAM,GAAG;YACd,WAAW,EAAE,MAAM,CAAC,iBAAiB;YACrC,KAAK,EAAE,MAAM,CAAC,WAAW;YACzB,gBAAgB,EAAE,MAAM,CAAC,sBAAsB;SAChD,CAAC;KACH;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,aAAa;IAoBxB,gBAAgB;IAChB,YAAoB,KAAyB;QAC3C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,KAAK,CAAC,YAAY;YACpB,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAE7E,IAAI,KAAK,CAAC,MAAM;YACd,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAtBD;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,SAAS,KAAK,KAAK,CAAC,iBAAiB;YAC/E,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAYD,qDAAqD;IAC9C,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,IAAI,KAAK,aAAa,CAAC,QAAQ;YACjC,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;YACtC,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,2GAA2G;IACpG,KAAK,CAAC,YAAgC;QAC3C,OAAO,aAAa,CAAC,QAAQ,CAAC;YAC5B,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,KAAoB;QAChC,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB;YACpD,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC;YAC1E,OAAO,KAAK,CAAC;aACV,IAAI,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,YAAa,CAAC;YAC1E,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,QAAQ,CAAC;YAClE,OAAO,KAAK,CAAC;QAEf,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC,CAAC;IAC9E,CAAC;;AAEsB,sBAAQ,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { Range1d, Range1dProps } from \"@itwin/core-geometry\";\nimport { ThematicGradientSettings, ThematicGradientSettingsProps } from \"./ThematicDisplay\";\nimport { Gradient } from \"./Gradient\";\n\n/** JSON representation of an [[AnalysisStyleDisplacement]].\n * @see [[AnalysisStyleProps.displacement]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleDisplacementProps {\n  /** See [[AnalysisStyleDisplacement.channelName]]. */\n  channelName: string;\n  /** See [[AnalysisStyleDisplacement.scale]].\n   * Default value: 1.\n   */\n  scale?: number;\n}\n\n/** Describes how an [[AnalysisStyle]] deforms a [Polyface]($core-geometry) by applying translation to its vertices.\n * @see [[AnalysisStyle.displacement]].\n * @public\n */\nexport class AnalysisStyleDisplacement {\n  /** The name of the [AuxChannel]($core-geometry) supplying the displacements to be applied to the vertices. */\n  public readonly channelName: string;\n  /** A scale applied to the displacements to adjust the magnitude of the effect.\n   * Default value: 1.\n   */\n  public readonly scale: number;\n\n  /** @internal */\n  private constructor(channelName: string, scale = 1) {\n    this.channelName = channelName;\n    this.scale = scale;\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: AnalysisStyleDisplacementProps): AnalysisStyleDisplacement {\n    return new this(props.channelName, props.scale);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): AnalysisStyleDisplacementProps {\n    const props: AnalysisStyleDisplacementProps = { channelName: this.channelName };\n    if (this.scale !== 1)\n      props.scale = this.scale;\n\n    return props;\n  }\n\n  /** Return true if `this` is equivalent to `other`. */\n  public equals(other: AnalysisStyleDisplacement): boolean {\n    return this.channelName === other.channelName && this.scale === other.scale;\n  }\n}\n\n/** JSON representation of an [[AnalysisStyleThematic]].\n * @see [[AnalysisStyleProps.scalar]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleThematicProps {\n  /** See [[AnalysisStyleThematic.channelName]]. */\n  channelName: string;\n  /** See [[AnalysisStyleThematic.range]]. */\n  range: Range1dProps;\n  /** See [[AnalysisStyleThematic.thematicSettings]].\n   * Default value: [[ThematicGradientSettings.defaults]].\n   */\n  thematicSettings?: ThematicGradientSettingsProps;\n}\n\n/** Describes how an [[AnalysisStyle]] recolors [Polyface]($core-geometry) vertices by mapping values of type\n * [AuxChannelDataType.Scalar]($core-geometry) or [AuxChannelDataType.Distance]($core-geometry) supplied\n * by an [AuxChannel]($core-geometry) to colors supplied by a [[Gradient]] image.\n * @see [[AnalysisStyle.thematic]].\n * @public\n */\nexport class AnalysisStyleThematic {\n  /** The name of the [AuxChannel]($core-geometry) supplying the values from which the vertex colors are computed. */\n  public readonly channelName: string;\n  /** The minimum and maximum values that map to colors in the [[Gradient]] image. Vertices with values outside of\n   * this range are displayed with the gradient's margin color.\n   */\n  public readonly range: Readonly<Range1d>;\n  /** Settings used to produce the [[Gradient]] image. */\n  public readonly thematicSettings: ThematicGradientSettings;\n  private _gradient?: Gradient.Symb;\n\n  /** @internal */\n  private constructor(props: AnalysisStyleThematicProps) {\n    this.channelName = props.channelName;\n    this.range = Range1d.fromJSON(props.range);\n    this.thematicSettings = ThematicGradientSettings.fromJSON(props.thematicSettings);\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: AnalysisStyleThematicProps): AnalysisStyleThematic {\n    return new this(props);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): AnalysisStyleThematicProps {\n    const props: AnalysisStyleThematicProps = {\n      channelName: this.channelName,\n      range: this.range.toJSON(),\n    };\n\n    if (!this.thematicSettings.equals(ThematicGradientSettings.defaults))\n      props.thematicSettings = this.thematicSettings.toJSON();\n\n    return props;\n  }\n\n  /** The gradient computed from [[thematicSettings]]. */\n  public get gradient(): Gradient.Symb {\n    if (!this._gradient)\n      this._gradient = Gradient.Symb.createThematic(this.thematicSettings);\n\n    return this._gradient;\n  }\n\n  /** Return true if `this` is equivalent to `other`. */\n  public equals(other: AnalysisStyleThematic): boolean {\n    return this.channelName === other.channelName && this.range.isAlmostEqual(other.range) && this.thematicSettings.equals(other.thematicSettings);\n  }\n}\n\n/** JSON representation of an [[AnalysisStyle]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleProps {\n  /** See [[AnalysisStyle.displacement]]. */\n  displacement?: AnalysisStyleDisplacementProps;\n  /** JSON representation of [[AnalysisStyle.thematic]].\n   * @note The name \"scalar\" is used instead of \"thematic\" for backwards compatibility.\n   */\n  scalar?: AnalysisStyleThematicProps;\n  /** See [[AnalysisStyle.normalChannelName]]. */\n  normalChannelName?: string;\n}\n\n/** At time of writing, the only iModel in existence that uses AnalysisStyle is the one created by the analysis-importer test app.\n * To avoid breaking existing saved views of that iModel, AnalysisStyle.fromJSON() continues  to accept the old JSON representation -\n * but that representation is not part of the public API.\n * @internal exported strictly for tests.\n */\nexport interface LegacyAnalysisStyleProps {\n  displacementChannelName?: string;\n  scalarChannelName?: string;\n  normalChannelName?: string;\n  displacementScale?: number;\n  scalarRange?: Range1dProps;\n  scalarThematicSettings?: ThematicGradientSettingsProps;\n}\n\nfunction tryConvertLegacyProps(input: AnalysisStyleProps): AnalysisStyleProps {\n  if (input.displacement || input.scalar)\n    return input;\n\n  const legacy = input as LegacyAnalysisStyleProps;\n  if (undefined === legacy.displacementChannelName && undefined === legacy.scalarChannelName)\n    return input;\n\n  const output: AnalysisStyleProps = {\n    normalChannelName: input.normalChannelName,\n  };\n\n  if (undefined !== legacy.displacementChannelName) {\n    output.displacement = {\n      channelName: legacy.displacementChannelName,\n      scale: legacy.displacementScale,\n    };\n  }\n\n  if (undefined !== legacy.scalarChannelName && undefined !== legacy.scalarRange) {\n    output.scalar = {\n      channelName: legacy.scalarChannelName,\n      range: legacy.scalarRange,\n      thematicSettings: legacy.scalarThematicSettings,\n    };\n  }\n\n  return output;\n}\n\n/** As part of a [[DisplayStyleSettings]], describes how to animate meshes in the view that have been augmented with\n * [PolyfaceAuxData]($core-geometry). The style specifies which channels to use, and can deform the meshes by\n * translating vertices and/or recolor vertices using [[ThematicDisplay]].\n * @see [[DisplayStyleSettings.analysisStyle]] to define the analysis style for a [DisplayStyle]($backend).\n * @see [[DisplayStyleSettings.analysisFraction]] to control playback of the animation.\n * @public\n */\nexport class AnalysisStyle {\n  public readonly displacement?: AnalysisStyleDisplacement;\n  public readonly thematic?: AnalysisStyleThematic;\n  /** If defined, the name of the [AuxChannel]($core-geometry) from which to obtain normal vectors for the vertices. */\n  public readonly normalChannelName?: string;\n\n  /** Create an analysis style from its JSON representation.\n   * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.\n   */\n  public static fromJSON(props?: AnalysisStyleProps): AnalysisStyle {\n    if (!props)\n      return this.defaults;\n\n    props = tryConvertLegacyProps(props);\n    if (!props.displacement && !props.scalar && undefined === props.normalChannelName)\n      return this.defaults;\n\n    return new AnalysisStyle(props);\n  }\n\n  /** @internal */\n  private constructor(props: AnalysisStyleProps) {\n    this.normalChannelName = props.normalChannelName;\n    if (props.displacement)\n      this.displacement = AnalysisStyleDisplacement.fromJSON(props.displacement);\n\n    if (props.scalar)\n      this.thematic = AnalysisStyleThematic.fromJSON(props.scalar);\n  }\n\n  /** Convert this style to its JSON representation. */\n  public toJSON(): AnalysisStyleProps {\n    const props: AnalysisStyleProps = {};\n    if (this === AnalysisStyle.defaults)\n      return props;\n\n    if (this.displacement)\n      props.displacement = this.displacement.toJSON();\n\n    if (this.thematic)\n      props.scalar = this.thematic.toJSON();\n\n    if (undefined !== this.normalChannelName)\n      props.normalChannelName = this.normalChannelName;\n\n    return props;\n  }\n\n  /** Produce a copy of this style identical except for properties explicitly specified by `changedProps`. */\n  public clone(changedProps: AnalysisStyleProps): AnalysisStyle {\n    return AnalysisStyle.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n\n  /** Return true if this style is equivalent to `other`. */\n  public equals(other: AnalysisStyle): boolean {\n    if (this.normalChannelName !== other.normalChannelName)\n      return false;\n\n    if ((undefined === this.displacement) !== (undefined === other.displacement))\n      return false;\n    else if (this.displacement && !this.displacement.equals(other.displacement!))\n      return false;\n\n    if ((undefined === this.thematic) !== (undefined === other.thematic))\n      return false;\n\n    return undefined === this.thematic || this.thematic.equals(other.thematic!);\n  }\n\n  public static readonly defaults = new AnalysisStyle({});\n}\n"]}

package/lib/esm/AuthorizationClient.d.ts

@@ -1,12 +1,12 @@
-/** @packageDocumentation
- * @module Authorization
- */
-import { AccessToken } from "@itwin/core-bentley";
-/** Interface to provide authorization information
- * @beta
- */
-export interface AuthorizationClient {
-    /** Get the AccessToken of the currently authorized user, or blank string if no token is available. */
-    getAccessToken(): Promise<AccessToken>;
-}
+/** @packageDocumentation
+ * @module Authorization
+ */
+import { AccessToken } from "@itwin/core-bentley";
+/** Interface to provide authorization information
+ * @beta
+ */
+export interface AuthorizationClient {
+    /** Get the AccessToken of the currently authorized user, or blank string if no token is available. */
+    getAccessToken(): Promise<AccessToken>;
+}
 //# sourceMappingURL=AuthorizationClient.d.ts.map

package/lib/esm/AuthorizationClient.js

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Authorization
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Authorization
+ */
+export {};
 //# sourceMappingURL=AuthorizationClient.js.map

package/lib/esm/AuthorizationClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"AuthorizationClient.js","sourceRoot":"","sources":["../../src/AuthorizationClient.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Authorization\r\n */\r\n\r\nimport { AccessToken } from \"@itwin/core-bentley\";\r\n\r\n/** Interface to provide authorization information\r\n * @beta\r\n */\r\nexport interface AuthorizationClient {\r\n  /** Get the AccessToken of the currently authorized user, or blank string if no token is available. */\r\n  getAccessToken(): Promise<AccessToken>;\r\n}\r\n"]}
+{"version":3,"file":"AuthorizationClient.js","sourceRoot":"","sources":["../../src/AuthorizationClient.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Authorization\n */\n\nimport { AccessToken } from \"@itwin/core-bentley\";\n\n/** Interface to provide authorization information\n * @beta\n */\nexport interface AuthorizationClient {\n  /** Get the AccessToken of the currently authorized user, or blank string if no token is available. */\n  getAccessToken(): Promise<AccessToken>;\n}\n"]}

package/lib/esm/BackgroundMapProvider.d.ts

@@ -1,52 +1,52 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { DeprecatedBackgroundMapProps } from "./BackgroundMapSettings";
-/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
- * @public
- * @extensions
- */
-export declare enum BackgroundMapType {
-    Street = 1,
-    Aerial = 2,
-    Hybrid = 3
-}
-/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.
- * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).
- * @public
- * @extensions
- */
-export declare type BackgroundMapProviderName = "BingProvider" | "MapBoxProvider";
-/** JSON representation of a [[BackgroundMapProvider]].
- * @see [[BaseMapLayerProps.provider]].
- * @public
- */
-export interface BackgroundMapProviderProps {
-    /** The name of the provider. Default: "BingProvider" */
-    name?: BackgroundMapProviderName;
-    /** The type of imagery to display. Default: Hybrid. */
-    type?: BackgroundMapType;
-}
-/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
- * @public
- */
-export declare class BackgroundMapProvider {
-    /** The name of the provider. */
-    readonly name: BackgroundMapProviderName;
-    /** The type of map imagery provided. */
-    readonly type: BackgroundMapType;
-    private constructor();
-    /** Create a provider from its JSON representation. */
-    static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider;
-    /** Convert this provider to its JSON representation. */
-    toJSON(): BackgroundMapProviderProps;
-    /** @internal */
-    static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider;
-    /** Return true if this provider is equivalent to `other`. */
-    equals(other: BackgroundMapProvider): boolean;
-    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
-     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
-     */
-    clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { DeprecatedBackgroundMapProps } from "./BackgroundMapSettings";
+/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
+ * @public
+ * @extensions
+ */
+export declare enum BackgroundMapType {
+    Street = 1,
+    Aerial = 2,
+    Hybrid = 3
+}
+/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.
+ * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).
+ * @public
+ * @extensions
+ */
+export declare type BackgroundMapProviderName = "BingProvider" | "MapBoxProvider";
+/** JSON representation of a [[BackgroundMapProvider]].
+ * @see [[BaseMapLayerProps.provider]].
+ * @public
+ */
+export interface BackgroundMapProviderProps {
+    /** The name of the provider. Default: "BingProvider" */
+    name?: BackgroundMapProviderName;
+    /** The type of imagery to display. Default: Hybrid. */
+    type?: BackgroundMapType;
+}
+/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
+ * @public
+ */
+export declare class BackgroundMapProvider {
+    /** The name of the provider. */
+    readonly name: BackgroundMapProviderName;
+    /** The type of map imagery provided. */
+    readonly type: BackgroundMapType;
+    private constructor();
+    /** Create a provider from its JSON representation. */
+    static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider;
+    /** Convert this provider to its JSON representation. */
+    toJSON(): BackgroundMapProviderProps;
+    /** @internal */
+    static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider;
+    /** Return true if this provider is equivalent to `other`. */
+    equals(other: BackgroundMapProvider): boolean;
+    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
+     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
+     */
+    clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider;
+}
 //# sourceMappingURL=BackgroundMapProvider.d.ts.map

package/lib/esm/BackgroundMapProvider.js

@@ -1,65 +1,65 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module DisplayStyles
- */
-/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
- * @public
- * @extensions
- */
-export var BackgroundMapType;
-(function (BackgroundMapType) {
-    BackgroundMapType[BackgroundMapType["Street"] = 1] = "Street";
-    BackgroundMapType[BackgroundMapType["Aerial"] = 2] = "Aerial";
-    BackgroundMapType[BackgroundMapType["Hybrid"] = 3] = "Hybrid";
-})(BackgroundMapType || (BackgroundMapType = {}));
-/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
- * @public
- */
-export class BackgroundMapProvider {
-    constructor(name, type) {
-        this.name = name;
-        this.type = type;
-    }
-    /** Create a provider from its JSON representation. */
-    static fromJSON(props) {
-        const name = props.name === "MapBoxProvider" ? props.name : "BingProvider";
-        let type;
-        switch (props.type) {
-            case BackgroundMapType.Street:
-            case BackgroundMapType.Aerial:
-                type = props.type;
-                break;
-            default:
-                type = BackgroundMapType.Hybrid;
-                break;
-        }
-        return new BackgroundMapProvider(name, type);
-    }
-    /** Convert this provider to its JSON representation. */
-    toJSON() {
-        return { name: this.name, type: this.type };
-    }
-    /** @internal */
-    static fromBackgroundMapProps(props) {
-        var _a;
-        // eslint-disable-next-line deprecation/deprecation
-        return this.fromJSON({ name: props.providerName, type: (_a = props.providerData) === null || _a === void 0 ? void 0 : _a.mapType });
-    }
-    /** Return true if this provider is equivalent to `other`. */
-    equals(other) {
-        return this.name === other.name && this.type === other.type;
-    }
-    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
-     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
-     */
-    clone(changedProps) {
-        return BackgroundMapProvider.fromJSON({
-            ...this.toJSON(),
-            ...changedProps,
-        });
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
+ * @public
+ * @extensions
+ */
+export var BackgroundMapType;
+(function (BackgroundMapType) {
+    BackgroundMapType[BackgroundMapType["Street"] = 1] = "Street";
+    BackgroundMapType[BackgroundMapType["Aerial"] = 2] = "Aerial";
+    BackgroundMapType[BackgroundMapType["Hybrid"] = 3] = "Hybrid";
+})(BackgroundMapType || (BackgroundMapType = {}));
+/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
+ * @public
+ */
+export class BackgroundMapProvider {
+    constructor(name, type) {
+        this.name = name;
+        this.type = type;
+    }
+    /** Create a provider from its JSON representation. */
+    static fromJSON(props) {
+        const name = props.name === "MapBoxProvider" ? props.name : "BingProvider";
+        let type;
+        switch (props.type) {
+            case BackgroundMapType.Street:
+            case BackgroundMapType.Aerial:
+                type = props.type;
+                break;
+            default:
+                type = BackgroundMapType.Hybrid;
+                break;
+        }
+        return new BackgroundMapProvider(name, type);
+    }
+    /** Convert this provider to its JSON representation. */
+    toJSON() {
+        return { name: this.name, type: this.type };
+    }
+    /** @internal */
+    static fromBackgroundMapProps(props) {
+        var _a;
+        // eslint-disable-next-line deprecation/deprecation
+        return this.fromJSON({ name: props.providerName, type: (_a = props.providerData) === null || _a === void 0 ? void 0 : _a.mapType });
+    }
+    /** Return true if this provider is equivalent to `other`. */
+    equals(other) {
+        return this.name === other.name && this.type === other.type;
+    }
+    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
+     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
+     */
+    clone(changedProps) {
+        return BackgroundMapProvider.fromJSON({
+            ...this.toJSON(),
+            ...changedProps,
+        });
+    }
+}
 //# sourceMappingURL=BackgroundMapProvider.js.map

package/lib/esm/BackgroundMapProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,iBAAiB,CAAC,MAAM,CAAC;YAC9B,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAChC,MAAM;SACT;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wDAAwD;IACjD,MAAM;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;;QACtE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAyC,EAAE,IAAI,EAAE,MAAA,KAAK,CAAC,YAAY,0CAAE,OAAO,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAwC;QACnD,OAAO,qBAAqB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BackgroundMapType {\r\n  Street = 1,\r\n  Aerial = 2,\r\n  Hybrid = 3,\r\n}\r\n\r\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\r\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\r\n\r\n/** JSON representation of a [[BackgroundMapProvider]].\r\n * @see [[BaseMapLayerProps.provider]].\r\n * @public\r\n */\r\nexport interface BackgroundMapProviderProps {\r\n  /** The name of the provider. Default: \"BingProvider\" */\r\n  name?: BackgroundMapProviderName;\r\n  /** The type of imagery to display. Default: Hybrid. */\r\n  type?: BackgroundMapType;\r\n}\r\n\r\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport class BackgroundMapProvider {\r\n  /** The name of the provider. */\r\n  public readonly name: BackgroundMapProviderName;\r\n  /** The type of map imagery provided. */\r\n  public readonly type: BackgroundMapType;\r\n\r\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\r\n    this.name = name;\r\n    this.type = type;\r\n  }\r\n\r\n  /** Create a provider from its JSON representation. */\r\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\r\n    let type;\r\n    switch (props.type) {\r\n      case BackgroundMapType.Street:\r\n      case BackgroundMapType.Aerial:\r\n        type = props.type;\r\n        break;\r\n      default:\r\n        type = BackgroundMapType.Hybrid;\r\n        break;\r\n    }\r\n\r\n    return new BackgroundMapProvider(name, type);\r\n  }\r\n\r\n  /** Convert this provider to its JSON representation. */\r\n  public toJSON(): BackgroundMapProviderProps {\r\n    return { name: this.name, type: this.type };\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\r\n  }\r\n\r\n  /** Return true if this provider is equivalent to `other`. */\r\n  public equals(other: BackgroundMapProvider): boolean {\r\n    return this.name === other.name && this.type === other.type;\r\n  }\r\n\r\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\r\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    return BackgroundMapProvider.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,iBAAiB,CAAC,MAAM,CAAC;YAC9B,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAChC,MAAM;SACT;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wDAAwD;IACjD,MAAM;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;;QACtE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAyC,EAAE,IAAI,EAAE,MAAA,KAAK,CAAC,YAAY,0CAAE,OAAO,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAwC;QACnD,OAAO,qBAAqB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\n * @public\n * @extensions\n */\nexport enum BackgroundMapType {\n  Street = 1,\n  Aerial = 2,\n  Hybrid = 3,\n}\n\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\n * @public\n * @extensions\n */\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\n\n/** JSON representation of a [[BackgroundMapProvider]].\n * @see [[BaseMapLayerProps.provider]].\n * @public\n */\nexport interface BackgroundMapProviderProps {\n  /** The name of the provider. Default: \"BingProvider\" */\n  name?: BackgroundMapProviderName;\n  /** The type of imagery to display. Default: Hybrid. */\n  type?: BackgroundMapType;\n}\n\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\n * @public\n */\nexport class BackgroundMapProvider {\n  /** The name of the provider. */\n  public readonly name: BackgroundMapProviderName;\n  /** The type of map imagery provided. */\n  public readonly type: BackgroundMapType;\n\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\n    this.name = name;\n    this.type = type;\n  }\n\n  /** Create a provider from its JSON representation. */\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\n    let type;\n    switch (props.type) {\n      case BackgroundMapType.Street:\n      case BackgroundMapType.Aerial:\n        type = props.type;\n        break;\n      default:\n        type = BackgroundMapType.Hybrid;\n        break;\n    }\n\n    return new BackgroundMapProvider(name, type);\n  }\n\n  /** Convert this provider to its JSON representation. */\n  public toJSON(): BackgroundMapProviderProps {\n    return { name: this.name, type: this.type };\n  }\n\n  /** @internal */\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\n  }\n\n  /** Return true if this provider is equivalent to `other`. */\n  public equals(other: BackgroundMapProvider): boolean {\n    return this.name === other.name && this.type === other.type;\n  }\n\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\n   */\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\n    return BackgroundMapProvider.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n}\n"]}