Skip to main content

Interface: RawShapes

Defined in: model/shapes.ts:38

A two-dimensional shape cloud

Extends​

Properties​

dataSource​

dataSource: RawShapesDataSource

Defined in: model/base.ts:53

Data source

Inherited from​

RawRenderedItemsDataObject.dataSource


id​

id: string

Defined in: model/base.ts:47

Data object ID

Inherited from​

RawRenderedItemsDataObject.id


layer​

layer: string | TableColumnRef

Defined in: model/base.ts:236

Layer ID

Can be specified as:

  • An ID of an existing Layer
  • A table column holding the layer ID values for each item, of the object's own table unless it names another

Inherited from​

RawRenderedItemsDataObject.layer


name​

name: string

Defined in: model/base.ts:50

Human-readable data object name

Inherited from​

RawRenderedItemsDataObject.name


opacity?​

optional opacity?: number

Defined in: model/base.ts:112

Data object opacity, in the range [0, 1]

Default Value​

renderedDataObjectDefaults.opacity

Inherited from​

RawRenderedItemsDataObject.opacity


shapeFillColor?​

optional shapeFillColor?: ColorConfig

Defined in: model/shapes.ts:65

Shape fill color

Default Value​

shapesDefaults.shapeFillColor


shapeFillOpacity?​

optional shapeFillOpacity?: OpacityConfig

Defined in: model/shapes.ts:79

Shape fill opacity

Default Value​

shapesDefaults.shapeFillOpacity


shapeFillVisibility?​

optional shapeFillVisibility?: VisibilityConfig

Defined in: model/shapes.ts:72

Shape fill visibility

Default Value​

shapesDefaults.shapeFillVisibility


shapeOpacity?​

optional shapeOpacity?: OpacityConfig

Defined in: model/shapes.ts:58

Shape opacity

Multiplies shapeFillOpacity and shapeStrokeOpacity.

Default Value​

shapesDefaults.shapeOpacity


shapeStrokeColor?​

optional shapeStrokeColor?: ColorConfig

Defined in: model/shapes.ts:86

Shape stroke color

Default Value​

shapesDefaults.shapeStrokeColor


shapeStrokeOpacity?​

optional shapeStrokeOpacity?: OpacityConfig

Defined in: model/shapes.ts:100

Shape stroke opacity

Default Value​

shapesDefaults.shapeStrokeOpacity


shapeStrokeVisibility?​

optional shapeStrokeVisibility?: VisibilityConfig

Defined in: model/shapes.ts:93

Shape stroke visibility

Default Value​

shapesDefaults.shapeStrokeVisibility


shapeVisibility?​

optional shapeVisibility?: VisibilityConfig

Defined in: model/shapes.ts:49

Shape visibility

Applies to both the fill and the stroke of a shape, on top of shapeFillVisibility and shapeStrokeVisibility.

Default Value​

shapesDefaults.shapeVisibility


transform?​

optional transform?: SimilarityTransform

Defined in: model/base.ts:119

Transformation from data object space to layer space

Default Value​

renderedDataObjectDefaults.transform

Inherited from​

RawRenderedItemsDataObject.transform


visibility?​

optional visibility?: boolean

Defined in: model/base.ts:105

Data object visibility

Default Value​

renderedDataObjectDefaults.visibility

Inherited from​

RawRenderedItemsDataObject.visibility