LineStyleDefinition.Utils Class
Helper methods for creating and querying line styles
Methods
| Name | Description | |
|---|---|---|
| constructor(): LineStyleDefinition.Utils | ||
| createCompoundComponent(txn: EditTxn, props: LineStyleDefinition.CompoundProps): LineStyleDefinition.StyleProps Static | Create a file property for a new compound component using an explicit EditTxn. | |
| createCompoundComponent(iModel: IModelDb, props: LineStyleDefinition.CompoundProps): LineStyleDefinition.StyleProps Static | Create a file property for a new compound component. | Deprecated |
| createPointSymbolComponent(txn: EditTxn, props: LineStyleDefinition.PointSymbolProps): LineStyleDefinition.StyleProps | undefined Static | Create a file property for a new point symbol component using an explicit EditTxn. | |
| createPointSymbolComponent(iModel: IModelDb, props: LineStyleDefinition.PointSymbolProps): LineStyleDefinition.StyleProps | undefined Static | Create a file property for a new point symbol component. | Deprecated |
| createRasterComponent(txn: EditTxn, props: LineStyleDefinition.RasterImageProps, image: Uint8Array): LineStyleDefinition.StyleProps | undefined Static | Create a file property for a new raster image component using an explicit EditTxn. | |
| createRasterComponent(iModel: IModelDb, props: LineStyleDefinition.RasterImageProps, image: Uint8Array): LineStyleDefinition.StyleProps | undefined Static | Create a file property for a new raster image component. | Deprecated |
| createStrokePatternComponent(txn: EditTxn, props: LineStyleDefinition.StrokePatternProps): LineStyleDefinition.StyleProps Static | Create a file property for a new stroke pattern component using an explicit EditTxn. | |
| createStrokePatternComponent(iModel: IModelDb, props: LineStyleDefinition.StrokePatternProps): LineStyleDefinition.StyleProps Static | Create a file property for a new stroke pattern component. | Deprecated |
| createStrokePointComponent(txn: EditTxn, props: LineStyleDefinition.StrokePointProps): LineStyleDefinition.StyleProps Static | Create a file property for a new stroke point component using an explicit EditTxn. | |
| createStrokePointComponent(iModel: IModelDb, props: LineStyleDefinition.StrokePointProps): LineStyleDefinition.StyleProps Static | Create a file property for a new stroke point component. | Deprecated |
| createStyle(txn: EditTxn, scopeModelId: string, name: string, props: LineStyleDefinition.StyleProps): string Static | Insert a new line style with the supplied name using an explicit EditTxn. | |
| createStyle(imodel: IModelDb, scopeModelId: string, name: string, props: LineStyleDefinition.StyleProps): string Static | Insert a new line style with the supplied name. | Deprecated |
| getContinuousStyleName(width?: number): string Static | Get the name that can be use to query for an existing continuous line style. | |
| getLinePixelsStyleName(linePixels: LinePixels): string | undefined Static | Get the name that can be use to query for an existing LinePixels line style. | |
| getOrCreateContinuousStyle(imodel: IModelDb, scopeModelId: string, width?: number, txn?: EditTxn): string Static | Query for a continuous line style that can be used to create curves with physical width instead of weight in pixels and create one if it does not already exist. | |
| getOrCreateLinePixelsStyle(imodel: IModelDb, scopeModelId: string, linePixels: LinePixels, txn?: EditTxn): string Static | Query for a line style using the supplied LinePixels value (Code1-Code7) and create one if it does not already exist. | |
| queryStyle(imodel: IModelDb, scopeModelId: string, name: string): string | undefined Static | Query for an existing line style with the supplied name. |
Defined in
- backend/src/LineStyle.ts Line 326
Last Updated: 03 August, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.