This file consolidates all functions available via rpc.invoke() from the Giraffe SDK.
Example
import { rpc } from "@gi-nx/iframe-sdk";
rpc.invoke("functionName", [arg1, arg2, ...]);Commands
Content
- PackContents
- ANALYTICS_IN_BUNDLE
- APPS_IN_BUNDLE
- BLOCKS_IN_BUNDLE
- FLOW_IN_BUNDLE
- LAYER_IN_BUNDLE
- REPORT_BUILDER_IN_BUNDLE
- SECTIONS_IN_BUNDLE
- USAGE_IN_BUNDLE
- addContentPackToProject
Engine
Evaluate a set of raw sections against the current project state, producing pre-stacked sections keyed by feature ID.
Accepts an optional context object to use a different project, not the current project.
Pass { stack: true } as the third argument to also stack the results in the same call (returning StackedSection arrays), avoiding a second round-trip through stackFeatures.
Polygon winding: Input polygon geometries must follow the RFC 7946 right-hand rule — outer rings counter-clockwise, holes clockwise. The evaluator does not rewind input; incorrectly-wound polygons may produce empty, inverted, or otherwise incorrect output. If your source does not guarantee RFC 7946 winding, rewind first (e.g. with @mapbox/geojson-rewind).
Flows
- NodeIds
- addFlow
addFlowDag- deleteFlow
deleteFlowDag- getNode
- getParameterNode
- getParameterNodeDefaultTransform
updateFlowDags- updateFlows
LayerTree
- activateViewLayers
- changeLayerOpacity
- changeLayerVisibility
- createLayerGroup
- moveLayerTreeItemIntoGroup
- removeLayerGroup
- reorderLayerTreeItem
Layers
- activateLensLayer
- addLayerToProject
addProjectLayer- addTempLayer
- addTempLayerGeoJSON
- createGeoJSONLayer
- createLayer
- deactivateLensLayer
- deleteProjectLayer
- getLayerContents
- getLayerPermission
- removeTempLayer
- setTiles
- updateGeoJSONLayerContents
- updateLayer
- updateLayerStyle
- updateTempLayerGeoJSON
Map
- addHtmlPopup
- clearSDKPopup
- fitBounds
- flyTo
- getFeatureState
- getMapBounds
- getMapboxLayerIdsForLayer
- getMapStyle
- getQueriedFeature
- getSelectedFeatures
- setDrawTool
- setHighlightedFeatures
- setSelectedFeatures
Misc
- addMapboxEventListener
- disableBottomBarIframe
- disableMapContentEvents
- disableMapHover
- disableSecondaryAppOverlay
- enableBottomBarIframe
- enableMapContentEvents
- enableMapHover
- enableSecondaryAppOverlay
- featureArea
- fromProjected
- getAnalyticsResult
- getGeoTiff
- getGltf
- getPng
- getSourceLayerDetails
- getTeamList
- getTerrainMeshes
- getTiles
- getUrlParams
- getUserClaimsJwt
- getVectorLayerContents
- readyToClose
- removeMapboxEventListener
- setContextMenuItems
- setTopView
- setUserData
- toProjected
- updateUiLayout
Other
- AdvancedOperator
- SimpleOperator
- AdvancedFeatureFilter
- BooleanTypeFilter
- DateTypeFilter
- EvaluateFeaturesOptions
- Feature
- FeatureCollection
- GeometryFilterDefinition
- GiraffeFeatureCategories
- GiraffeState
- LineString
- MultiPolygon
- NumberTypeFilter
- Point
- Polygon
- PreStackedLineString
- PreStackedPoint
- PreStackedPolygon
- ProjectLayer
- ProjectOverrides
- RawLineString
- RawMultiLineString
- RawMultiPoint
- RawMultiPolygon
- RawPoint
- RawPolygon
- RawSectionProps
- SelectTypeFilter
- Team
- TextTypeFilter
- Tile
- View
- WorkspaceDetails
- AnalyticsResult
- AnimationOptions
- BlockDefinition
- BooleanFilterOperator
- CameraOptions
- DateStringFilterOperator
- DecisionType
- DrawTool
- EasingOptions
- FeatureId
- FileContentType
- fileTypeCategories
- FileTypeSubstring
- FilterOperator
- FlyToOptions
- GeoCoordinate
- GeoJsonFeature
- GeoJsonPolygon
- Geometry
- GeometryOperator
- GiFileForDocs
- GiraffeLensableStyle
- GiraffeNodeGraph
- GiraffeProjectBoundary
- GiraffeStateAttr
- GiraffeStateAttrMap
- GiraffeStateBakedSections
- GiraffeStateBlocks
- GiraffeStateClosingSignal
- GiraffeStateContextMenuClick
- GiraffeStateEvent
- GiraffeStateEventKey
- GiraffeStateFlows
- GiraffeStateGeoAttr
- GiraffeStateGet
- GiraffeStateLayerTree
- GiraffeStateMapboxEvent
- GiraffeStateMapContent
- GiraffeStateMapHoverCoords
- GiraffeStateMapSelectCoord
- GiraffeStateMapView
- GiraffeStateProject
- GiraffeStateProjectAppsByAppID
- GiraffeStateProjectLayers
- GiraffeStateProjectOrigin
- GiraffeStateProjects
- GiraffeStateRawSections
- GiraffeStateSelected
- GiraffeStateSelectedProjectApp
- GiraffeStateUiLayout
- GiraffeStateViews
- GiraffeStateVisibleScenarios
- GiraffeStateWorkspace
- GiSourceData
- LayerBundle
- LayerConfigOptions
- LayerPatch
- LensableGeometry
- LensPropertyFilterDefinition
- LensUiState
- LngLatBoundsLike
- LngLatLike
- MapboxLensable
- MapboxStyleLayer
- MapContent
- MapEvents
- MapOptions
- MapView
- NumberFilterOperator
- PaddingOptions
- PointLike
- PopupOptions
- PreStackedSection
- Project
- ProjectApp
- ProjectAttachment
- ProjectAttachmentType
- ProjectBoundary
- ProjectDetails
- ProjectFeatureCollection
- RawSection
- Scenario
- SDKLensable
- SdkUiLayout
- SharedCredential
- SimpleGeoJsonFeature
- SimplePropertyFilterDefinition
- StringArrayFilterOperator
- StringFilterOperator
- UploadProjectAttachmentOptions
- UserDefinedWorkspaceProperty
- ValuelessFilterOperator
- WorkspacePropertyTree
fetchProjectFiles- getTempUrl
toggleLensLayer- activateDrawingLayer
- addIframePopup
- clearIsolatedFeatures
- createBlock
- createDrawingLayer
- createProjectAttachmentPrompt
- createUsage
- deleteBlock
- deleteDrawingLayer
- deleteUsage
- disableIsolateMode
- drawPoint
- duplicateDrawingLayer
- enableIsolateMode
- fetchContentPacks
- fetchPackContents
- fetchProjectDetails
- fetchUserFiles
- fetchVistas
- getBlock
- getBlocks
- getIsolatedFeatures
- getIsolateMode
- getLassoedLensedFeatures
- getLassoedProjectFeatures
- getLassoShape
- getProjectFlows
- getProjectUsages
- getScenarios
- getSelectableProjectFeatures
- getUsage
- getUserData
- getUserDrawnPolygon
- getVisibleScenarios
- insertBlock
- loadImage
- navigateTo
- pickRawSections
- queryRenderedFeatures
- removeFeatureState
- removeLayerFromProject
- renameDrawingLayer
- renameScenario
- selectProjectAttachmentPrompt
- setFeatureState
- setIsolatedFeatures
- setScenarioVisibility
- soloScenario
- stackFeatures
- updateBlock
- updateUsage
- uploadProjectAttachment
Project
- createRawSection
- createRawSections
- deleteRawSection
- deleteRawSections
fetchAppCredentials- fetchCredentials
getProjectApp- importRawSections
- openProject
- updateProjectApp
- updateRawSection
- updateRawSections